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 120637 - Doc-comments not recognized
Doc-comments not recognized
Status: VERIFIED INCOMPLETE
Product: doxygen
Classification: Other
Component: general
1.5.3-SVN
Other Linux
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2003-08-25 04:55 UTC by Braden
Modified: 2009-08-15 18:40 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Test case (12.79 KB, text/plain)
2003-08-25 04:56 UTC, Braden
Details

Description Braden 2003-08-25 04:55:30 UTC
Doxygen seems not to be recognizing some doc-comments, and I'm not sure
why. I'll attach a test case.
Comment 1 Braden 2003-08-25 04:56:43 UTC
Created attachment 19477 [details]
Test case
Comment 2 Braden 2003-08-25 04:59:30 UTC
I apologize for the lack of brevity/focus in the test case. However,
attempts to condense it further changed the error messages in
unexpected ways.
Comment 3 Dimitri van Heesch 2003-09-04 19:57:44 UTC
This problem should be fixed in the new CVS update. Could you check
this for me?
Comment 4 Braden 2003-09-08 12:59:26 UTC
I'm still seeing a few problems with this test case:

 * Doxygen issues this complaint, which suggests something is amiss
with const handling:

  node.cpp:387: Warning: documented function
`openvrml::node_interface_set::const _iterator' was not defined.
  node.cpp:93: Warning: Member const_iterator of class
openvrml::node_interface_set is not documented.

Note the space inserted in the first warning message.
(node_interface::const_iterator does have a doc-comment.)

 * I get this warning, even though interface_id_matches_ is in an
unnamed namespace and marked @internal. I have EXTRACT_STATIC set to
NO and INTERNAL_DOCS set to NO.

  node.cpp:433: Warning: Compound openvrml::@2::interface_id_matches_
is not documented.

 * I get this warning:

  node.cpp:332: Warning: class `node_interface' for related function
`operator!=' is not documented.

... because I haven't explicitly qualified node_interface in @relates.
That is, if I said "openvrml::node_interface" instead, the warning
would go away. But since the doc-comment is inside the openvrml
namespace, I think I shouldn't have to do this.
Comment 5 Dimitri van Heesch 2004-08-04 15:24:23 UTC
Could you re-evalutate if these problems are still present in version 1.3.8 as I
don't see them anymore...
Comment 6 Braden 2004-08-23 16:57:40 UTC
Appears to be fixed.