Featured post
c - Customizing Doxygen html output -
we have function header format have follow. looks this
/** * name: blah * * parameters: * int foo * bool bar * * .....
we attempting generate documents doxygen, 1 issue when change code to:
/** * name: blah * * parameters: * \param int foo * \param bool bar * * .....
when doxygen generates html comments, adds parameters title. required have line 4, creates documents 2 lines parameters, first line 4 , second doxygen auto inserts.
what i'm hoping can either have doxygen ignore line 4 or add have not insert it's own "parameters:" title. know if possible?
the simple solution remove "parameters:" text altogether; entirely redundant since doxygen mark-up makes clear parameters!
for matter "name:" label entirely redundant too, , forces place name in both comment , code. why need that? it's name right there in code. unnecessary comment maintenance headache, , doxygen use teh name in code not name in comment in generated documentation.
if must attempt mix existing format doxygen compatible format easier use c++/c99 line comments rather block comments; c compilers support them:
// name: blah // // parameters: /// \param foo description of foo /// \param bar description of bar
note \param <type> <name>
not correct doxygen syntax; \param <name> <description>
. doxygen gets type code; again specifying type in comment entirely redundant, , maintenance headache.
i suggest employ more doxygen , maintenance friendly function boiler-plate altogether. use following basic form (for worth):
//! @brief brief description //! //! full description if necessary. //! @param p1 p1 description //! @param p2 p2 description //! @return return value description int foobar( int p1, int p2 ) ;
obviously whether use /// or //! , \ or @ matter of preference.
- Get link
- X
- Other Apps
Comments
Post a Comment