X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=docs%2Fcoding-style.html;h=99afe142f96800f3a7d9c653f7cd9e01eaac205a;hb=9f6631db37bdce7a2d8d000a4998d80d8d541514;hp=4a67b5827f2d1d569962e783160e7a376f1aba46;hpb=79ddebefe3424a76934fe193496da61cd3a1adb3;p=platform%2Fcore%2Fuifw%2Fdali-core.git diff --git a/docs/coding-style.html b/docs/coding-style.html index 4a67b58..99afe14 100644 --- a/docs/coding-style.html +++ b/docs/coding-style.html @@ -489,6 +489,30 @@ function toggleVisibility( button, obj ) Mark deprecated interface points with @deprecated comments. +

Doxygen Tags

+ + The following order should be followed when using doxygen tags for functions, classes, structs etc. + + + /** + * @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 + */ + + + Where X.X.X is the next release version (ensure you're patch gets merged before the release). +

Formatting