Re: [Doxygen-users] @internal effectively makes the function "undocumented" ?

[Monique S. <mon...@ea...>]

>From an off-list reply:

> Have you tried @private?   Doxygen seems very particular as to where the @private goes too.  If I put it in the comment block, I had
> problems.  Mine works ok like this:
> 

>    /**

>     * @brief Blah Blah Blah

>     * @param ae An Blah object.

>     */

>        void update(DDDTest ae)   /** @private */

>    {

>      …

>    }



Ah, I hadn’t thought of that! It does the job (I simply put the @private as the first thing in the Doxygen comment block), but it is extremely misleading to anyone who actually looks at the source code. (And this will happen because the Doxygen I’m working on is for internal use, not for customers. So the same developers who will use the Doxygen output will also be looking directly at the code.)



So what I did was create an alias, “dont_show”, for the @private command, and added a good explanation of it in the Doxyfile.



Thanks for the tip,

And hope this info and enhancement proves useful to others,

-Monique