After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 608014 - Incomplete description of \internal
Incomplete description of \internal
Status: RESOLVED OBSOLETE
Product: doxygen
Classification: Other
Component: documentation
1.6.1
Other Windows
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
[moved_to_github]
Depends on:
Blocks:
 
 
Reported: 2010-01-25 09:57 UTC by Michael Stockman
Modified: 2018-07-30 10:17 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Michael Stockman 2010-01-25 09:57:29 UTC
"This command writes the message `For internal use only' to the output"

The description does not say if it always does this or only if INTERNAL_DOCS=YES.

"all text after an \internal command until the end of the comment block or the end of the section (whichever comes first) is marked as "internal""

This does say which, but only for the text following \internal.


After reviewing some bugs about internal it appears to me that there is some confusion about the purpose of \internal. I might be slightly confused myself.
* Does \internal mean that the documented entity is "Only for internal use"?
* Does \internal mean that the part of the documentation following \internal until the end of the documentation block is "Only for internal use"?
Comment 1 André Klapper 2018-07-30 10:17:06 UTC
As discussed in https://github.com/doxygen/doxygen/pull/734 , Doxygen has moved its issue tracking to 

   https://github.com/doxygen/doxygen/issues

All Doxygen tickets in GNOME Bugzilla have been migrated to Github. You can subscribe and participate in the new ticket in Github. You can find the corresponding Github ticket by searching for its Bugzilla ID (number) in Github.

Hence I am closing this GNOME Bugzilla ticket.
Please use the corresponding ticket in Github instead. Thanks a lot!