-
Notifications
You must be signed in to change notification settings - Fork 6
Header doc format
pritigoel edited this page Feb 23, 2016
·
8 revisions
Class headers
/**
* @ingroup <Group related classes together>
*
* <Class description>
*/
Method headers
/*
- @param [in]
- @param [in]
- @return 0
- @return -1
- Example:
- @code
- {
-
<Code example snippet> - }
- @endcode
- @see */
Others (#define/enum/typedef)
/**
- single line
- paragraph */
Notes:
- Don't use @brief or @abstract or @discussion anywhere
- For descriptions of variables, use the multi-line comment as shown above in "Others"
Copyright (c) 2016, Xerox Corporation (Xerox) and Palo Alto Research Center (PARC). All rights reserved.