NFD » ndn-cxx

Task #2263

Updated by Junxiao Shi over 10 years ago

Add a code style rule on write Doxygen block. 

 This rule shall declare: 

 * block style: 

         /** \brief XXX 
          * 
          *    YYY 
          */ 
         -- vs --- 
         /** 
          * \brief XXX 
          * 
          * YYY 
          */ 

 * command style: `\brief` vs `@brief` 
 * indentation 

          /** \brief brief description, 
           *           more brief description 
           */ 
         -- vs --- 
          /** \brief brief description, 
           *    more brief description 
           */ 

 * verb usage 

     * `an Interest packet` 
     * `represents an Interest packet` 
     * `This type represents an Interest packet.` 

 * letter casing: `\brief Represents ...` vs `\brief represents ...` 

Back