@internal effectively makes the function "undocumented" ?
"Monique Semp" <[email protected]>
| Newsgroups | gmane.text.doxygen.general |
|---|---|
| Message-ID | <FDD2461847AA4AEE920E16F255F988B9@WQIMJS> |
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 ------------------------------------------------------------------------------ _______________________________________________ Doxygen-users mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/doxygen-users