How can I hide a particular function (in c++) in doxygen? -


i have class has may functions , want hide particular function. example

class test {     /**     * function1     *     * @param[in]  arg1  arg1     * @param[in]  arg2  arg2     */             public void function1(int arg1,char arg2);      // presume same documentation function     public void function2(int,char);      // presume same documentation function     public void function3(int,char);      // presume same documentation function     public void function4(int,char); }  

suppose want hide function2 how that.

now in current scenario displaying 4 functions along documentations.

now, have following attribute set in .doxygen rule file:

extract_all = yes

can please suggest me can hide function2?

thanks in advance.

do this:

#ifndef doxygen_should_skip_this   /* code must skipped doxygen */  /* in case method/function */  #endif /* doxygen_should_skip_this */ 

and in config file, put predefined = doxygen_should_skip_this make sure enable_preprocessing set yes.

in short, leveraging preprocessor concept work you!


Comments

Popular posts from this blog

apache - Remove .php and add trailing slash in url using htaccess not loading css -

javascript - jQuery show full size image on click -