Site Tools


iotivity_c_code_review_notes

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Last revision Both sides next revision
iotivity_c_code_review_notes [2015/02/12 09:48]
joncruz created
iotivity_c_code_review_notes [2015/02/12 09:58]
joncruz [FAQ] started a simple first question
Line 5: Line 5:
 ===== FAQ ===== ===== FAQ =====
  
-  * Q: Why..+  * Q: There was a ''​%%@fn%%''​ at the start of a comment. ​Why could this be an issue?<​code cpp> 
-    * A:+/** 
 + * @fn PerformOperation 
 + * Performs an operation on the placeholder. 
 + * 
 + * @return A status value. 
 + */ 
 +int PerformOperation();​ 
 +</​code>​ 
 +    * A: Doxygen will normally look after the comment to automatically determine what is being discussed. Adding an explicit tag can get out of sync, cause duplicate information or other errors. See [[Efficient Doxygen Comments#​Breakdown|Efficient Doxygen Comments]]
   * Q:   * Q:
     * A:     * A:
  
 (add more as they are encountered) (add more as they are encountered)
iotivity_c_code_review_notes.txt · Last modified: 2015/02/12 10:27 by joncruz