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 301897 - Support for D /+ ... +/ comment syntax
Support for D /+ ... +/ comment syntax
Status: RESOLVED OBSOLETE
Product: doxygen
Classification: Other
Component: build
1.4.x
Other All
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
[moved_to_github]
Depends on:
Blocks: 173045
 
 
Reported: 2005-04-25 10:37 UTC by Stewart Gordon
Modified: 2018-07-30 10:09 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Stewart Gordon 2005-04-25 10:37:48 UTC
The D language has an alternative comment notation to those found in C(++) and
Java.  It is denoted by /+ ... +/.

Doxygen doesn't recognise this feature of D at present, leading to commented-out
entities being documented nonetheless and garbage comments within function
signatures.

An important aspect of /+ ... +/ comments is that, unlike /* ... */ comments,
they can be nested.


Steps to reproduce:
1. Copy and paste these lines into a D source file:

    void uncommentedOutFunction() {}

    /+
    void commentedOutFunction() {}
    +/

    void functionWithCommentedOutParameter(int noComment/+, char[] comment+/) {}

2. Run Doxygen.


Actual results:
Comment markers are not recognised, so documentation comes out like this:

    Functions
    void  _uncommentedOutFunction_ ()
    void  _commentedOutFunction_ ()
    void  _functionWithCommentedOutParameter_ (int noComment/+, char[] comment+/)
    ----
    Function Documentation

    void commentedOutFunction( )

    void functionWithCommentedOutParameter( int noComment/+ ,
                                            char[]comment+/
                                          )

    void uncommentedOutFunction( )


Expected results:
Stripped away the comments, leaving this

    Functions
    void  _uncommentedOutFunction_ ()
    void  _functionWithCommentedOutParameter_ (int noComment)
    ----
    Function Documentation

    void functionWithCommentedOutParameter( int noComment )

    void uncommentedOutFunction( )


An open issue is whether Doxygen should support documentation comments done like
this.  There are two options: either strip away all /+ ... +/ comments, or
support documentation comments like this /+! ... +/.  (Further, is it worth
supporting JavaDoc-like /++ ... +/ and/or /+* ... +/ as well?)  Take your pick.

For the time being (pending bug 301895) at least, C preprocessor directives
occurring within /+ ... +/ should still be processed.
Comment 1 André Klapper 2018-07-30 10:09:09 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!