diff --git a/Doxyfile b/Doxyfile index b7514d3d..6ea4977f 100644 --- a/Doxyfile +++ b/Doxyfile @@ -536,7 +536,7 @@ FILE_VERSION_FILTER = # You can optionally specify a file name after the option, if omitted # DoxygenLayout.xml will be used as the name of the layout file. -LAYOUT_FILE = +LAYOUT_FILE = documentation/tmpl/layout.xml #--------------------------------------------------------------------------- # configuration options related to warning and progress messages diff --git a/documentation/text/documenting.dox b/documentation/text/documenting.dox new file mode 100644 index 00000000..c333f166 --- /dev/null +++ b/documentation/text/documenting.dox @@ -0,0 +1,43 @@ +/** + * @file documenting.dox + * @page documenting Documenting MetalSVM with Doxygen + * + * @section inline Documenting code inline + * + * To document your code correctly, you will have to follow some (easy) rules: + * + * Place a comment block like this at the beginning of your source code: + * + *
+ *  /**
+ *   *  \@author John Doe
+ *   *  \@file   path/to/your/file.h
+ *   *  \@brief  A brief explanation about what this code does or is supposed to do.
+ *   * /
+ * 
+ * + * Functions/procedures are commented in the header file just above the + * function/procedure definition: + * + *
+ * /** \@brief Blocking wait for semaphore [short explanation]
+ *  *
+ *  * [space for more detailed explanations]
+ *  *
+ *  * [describing parameters]
+ *  * \@param s Address of the according %sem_t structure
+ *  * \@param ms Timeout in milliseconds
+ *  *
+ *  * [describing possible return values in a list]
+ *  * \@return 
+ *  *	%- 0 on success
+ *  *	%- -EINVAL on invalid argument
+ *  *	%- -ETIME on timer expired
+ *  * /
+ * inline static int %sem_wait(sem_t* s, uint32_t ms); 
+ * 
+ * + * @section formatting Formatting text + * + * @section docs Writing documents like this one + */ diff --git a/documentation/text/kernelspace.dox b/documentation/text/kernelspace.dox new file mode 100644 index 00000000..95e014d4 --- /dev/null +++ b/documentation/text/kernelspace.dox @@ -0,0 +1,7 @@ +/** + * @file kernelspace.dox + * @page kernelspace Development in kernel space + * + * @section kernelthreads Starting kernel threads + * + */ diff --git a/documentation/text/userspace.dox b/documentation/text/userspace.dox new file mode 100644 index 00000000..9489f4d2 --- /dev/null +++ b/documentation/text/userspace.dox @@ -0,0 +1,7 @@ +/** + * @file userspace.dox + * @page userspace Development in user space + * + * @section ownapps Installing and launching your own applications + * + */ diff --git a/documentation/tmpl/layout.xml b/documentation/tmpl/layout.xml new file mode 100644 index 00000000..6794c866 --- /dev/null +++ b/documentation/tmpl/layout.xml @@ -0,0 +1,186 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +