Diff: object.h

Revision:

0:9b7c45516b5b

Child:

1:634c3fa7fbb6

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/object.h	Sat Mar 28 11:57:50 2020 +0000
@@ -0,0 +1,33 @@
+
+/**
+ * \brief   The function bar. 
+ *
+ * \details This function does something which is doing nothing. So this text
+ *          is totally senseless and you really do not need to read this,
+ *          because this text is basically saying nothing.
+ *
+ * \note    This text shall only show you, how such a \"note\" section
+ *          is looking. There is nothing which really needs your notice,
+ *          so you do not really need to read this section.
+ *
+ * \param[in]     a    Description of parameter a.
+ * \param[out]    b    Description of the parameter b.
+ * \param[in,out] c    Description of the parameter c.
+ *
+ * \return        The error return code of the function.
+ *
+ * \retval        ERR_SUCCESS    The function is successfully executed
+ * \retval        ERR_FAILURE    An error occurred
+ */
+ 
+/**
+ * Test doc
+ */
+
+/**
+ * Test an object
+ */
+struct Object{
+    /// Construct an object.
+    Object();
+};
\ No newline at end of file