<ARTICLE class="detail" id="macro_name_examples">
<CODE class="good">
#define DEBUG_TRACE( __FILE__, __LINE__ ) ...
- #ifndef __ACTOR_H__
- #define __ACTOR_H__
+ #ifndef ACTOR_H
+ #define ACTOR_H
...
- #endif // __ACTOR_H__
+ #endif // ACTOR_H
</CODE>
</ARTICLE>
</ARTICLE>
<SUMMARY>
Mark deprecated interface points with <code>@deprecated</code> comments.
</SUMMARY>
+ <H3>Doxygen Tags</H3>
+ <SUMMARY>
+ The following order should be followed when using doxygen tags for functions, classes, structs etc.
+ </SUMMARY>
+ <CODE class="good">
+ /**
+ * @deprecated DALi X.X.X Mandatory, if applicable // Version deprecated and alternative
+ * @brief Mandatory // Explain the API briefly
+ * @details Optional // Explain the API in more detail. Use this tag or add more
+ * // information after a blank line following the @brief
+ * @since DALi X.X.X Mandatory // Version added
+ * @param[in] Mandatory, if applicable // In Parameter list
+ * @param[out] Mandatory, if applicable // Out Parameter list
+ * @param[in,out] Mandatory, if applicable // In/Out Parameter list
+ * @return Mandatory, if applicable // Return value
+ * @pre Optional // Pre-condition
+ * @post Optional // Post-condition
+ * @note Optional // Any notes that apply
+ * @see Optional // Other related APIs
+ */
+ </CODE>
+ <SUMMARY>
+ Where X.X.X is the next release version (ensure you're patch gets merged before the release).
+ </SUMMARY>
</ARTICLE>
<H1>Formatting</H1>