43 lines
1.2 KiB
Text
43 lines
1.2 KiB
Text
/**
|
|
* @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:
|
|
*
|
|
* <pre>
|
|
* /**
|
|
* * \@author John Doe
|
|
* * \@file path/to/your/file.h
|
|
* * \@brief A brief explanation about what this code does or is supposed to do.
|
|
* * /
|
|
* </pre>
|
|
*
|
|
* Functions/procedures are commented in the header file just above the
|
|
* function/procedure definition:
|
|
*
|
|
* <pre>
|
|
* /** \@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);
|
|
* </pre>
|
|
*
|
|
* @section formatting Formatting text
|
|
*
|
|
* @section docs Writing documents like this one
|
|
*/
|