Geek asks and answers

Doxygen repeating C ++ functions with default arguments

I use Doxygen to document my code. I have a function that uses the default argument that is specified in the ie header:

unsigned int CountColumns(const std::string&,const std::string& delim="");

and the corresponding implementation in the source file:

unsigned int CountColumns(const string& input,const string& delim)
{
   ...
}

When I use Doxygen to create my documentation, CountColumns has two entries: one of which contains a default value, and one without:

unsigned int    CountColumns (const string &input, const string &delim)
unsigned int    CountColumns (const std::string &, const std::string &delim="")

How can this be avoided? I do not want several function descriptions cluttering up my documentation.

EDIT: , , "std::string", - " std::string ', " string" . 'std::string' , Doxygen , .

+5
3

BUILTIN_STL_SUPPORT YES , doxygen , - , std.

+5

- , "std::string", - "using std::string", "" . 'std::string' , Doxygen , .

, , .

+2

?

FAQ Doxygen,

" doxygen - ?

- \cond \endcond , . , .

doxygen :

 #ifndef DOXYGEN_SHOULD_SKIP_THIS

  /* code that must be skipped by Doxygen */

 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
 around the blocks that should be hidden and put:

   PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS
 in the config file then all blocks should be skipped by Doxygen as long as

= . "

0
source

More articles:


All Articles