Project

General

Profile

Actions
Copy link

Task #2263

open

code-style: Doxygen syntax

Added by Junxiao Shi about 11 years ago. Updated almost 7 years ago.

Status:
New
Priority:
Normal
Assignee:
-
Category:
Docs
Target version:
-
Start date:
Due date:
% Done:

0%

Estimated time:
1.00 h

Description

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 ...

Actions
Copy link

Also available in: Atom PDF