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 694218 - Comment beginning with "// Author" suppresses doc generation
Comment beginning with "// Author" suppresses doc generation
Status: RESOLVED OBSOLETE
Product: doxygen
Classification: Other
Component: build
1.8.3.1
Other Linux
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
[moved_to_github]
Depends on:
Blocks:
 
 
Reported: 2013-02-19 22:39 UTC by Doug Kramer
Modified: 2018-07-30 10:57 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Doug Kramer 2013-02-19 22:39:13 UTC
PROBLEM:
When I run doxygen on Objective-C source code with the following code block,
no documentation is generated for that method -- no signature, parameters or
doc comment.

CAUSE:
I tracked the cause down to this:
A comment line that starts with the string "// Author" prevents the entire
documentation for that method from being generated

SOLUTION:
Add a word before "Author", such as "// The authorization has finished"
enables the method's documentation to be generated

-------------------------------------------------------------
// A protocol implemented by the client.
@protocol MyClassDelegate

// Authorization is finished
- (void)finishedWithAuth:(OAuth2Authentication *)auth;

@end
--------------------------------------------------------------

$ doxygen --version
1.8.3.1
Comment 1 André Klapper 2018-07-30 10:57:27 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!