Skip to content

Commit

Permalink
Add comment descrptions
Browse files Browse the repository at this point in the history
  • Loading branch information
VidereLicet committed Nov 30, 2018
1 parent 602e0d1 commit 879d341
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions contrib/COMMENTS.md
Expand Up @@ -8,21 +8,30 @@ Comments in this library should be written as you develop new code. The practice
Comments should be included to support Doxygen building over methods and classes in header files.

```
/** Test Class
*
* Description of the class.
* Can be in as many lines as needed.
*
**/
class Test
{
public:
/** Describe Data Members. **/
/** Describe Data Member. **/
uint32_t nDataMember;
/** Function
*
* Function Description
*
* @param[in] nArg The argument for...
* @param[out] nRet The argument outputed for...
*
* @return returns the...
*
**/
void Function(uint32_t nArg);
bool Function(uint32_t nArg, uint32_t& nRet);
}
```

Expand All @@ -32,7 +41,7 @@ Inside the corresponding source files, the method description should be non-doxy

```
/* Function Description */
void Test::Function(uint32_t nArg)
bool Test::Function(uint32_t nArg, uint32_t& nRet)
{
/* Brief Description of Local Variable. */
uin32_t nSum = 0;
Expand Down

0 comments on commit 879d341

Please sign in to comment.