doxygen-users

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

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

Hello, doxygen users,

I’m using Doxygen 1.8.10, on Win7.

I’ve just added the @internal command to some functions that I want to omit from the generated Doxygen output. However, they’re showing up in the list of functions, albeit without any of the Doxygen comments. I believe this is because I have the HIDE_UNDOC_MEMBERS set to NO, which I’m doing while I document the code so that it’s obvious if I’ve missed something. (I’m the tech writer who’s documenting an existing body of code; I’m not a developer documenting as I go.)

I’d have expected the @internal command to cause a function to be treated as “documented” but to omit it from the output because it’s internal. Clearly that’s not the case.

So, is there a way to achieve what I’m looking for: include undocumented elements (so I can see what I’ve missed adding comments for), but exclude elements that have the @internal designation?

If not, I’ll just set the HIDE_UNDOC_MEMBERS to YES and be careful as I go, so not a big deal.

Thanks,
-Monique

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