Doxygen Issues
Difference (previous author) (Change, Edit, normal page display)
Changed: 3,4c3
|
D support was added to Doxygen version 1.3.6, and was working even before that using "dfilter" |
D support was added to  Doxygen version 1.3.6, and was working even before that using "dfilter" |
Changed: 6,7c5
|
However, there are still a few problems with using Doxygen for creating D documentation: |
|
However, there are still a few problems with using Doxygen for creating D documentation. |
Changed: 17,18c15,23
|
Tracker bug for D issues: http://bugzilla.gnome.org/show_bug.cgi?id=173045 |
|
Tracker bug for D issues: * http://bugzilla.gnome.org/show_bug.cgi?id=170235** debug and version conditionals are not supported ** "alias" not working (should be in D mode) * http://bugzilla.gnome.org/show_bug.cgi?id=172789** /+ +/ comments are not recognized ** attribute blocks not supported * "function" and "delegate" not working* templates not supported |
Changed: 20,32c25
|
* debug and version conditionals are not supported * "alias" not working (should be in D mode) http://bugzilla.gnome.org/show_bug.cgi?id=170235* /+ +/ comments are not recognized * attribute blocks not supported http://bugzilla.gnome.org/show_bug.cgi?id=172789* "function" and "delegate" not working http://bugzilla.gnome.org/show_bug.cgi?id=173041* templates not supported http://bugzilla.gnome.org/show_bug.cgi?id=173043Need to write a "unit test" of D code to be documented, so we can follow how much is working and how much is left. |
|
Need to write a "unit test" of D code to be documented, so we can follow how much is working and how much is left. |
Changed: 44c37
|
FILTER_PATTERNS = *.d=dfilter |
|
<n>{FILTER PATTERNS}? = *.d=dfilter</n> |
Changed: 54,57c47,50
|
* Posting:digitalmars.D.announce/241 (dfilter program) * Posting:digitalmars.D.announce/99* Posting:digitalmars.D/18764* Posting:digitalmars.D/11272 |
|
* NG:digitalmars.D.announce/241 (dfilter program) * NG:digitalmars.D.announce/99* NG:digitalmars.D/18764* NG:digitalmars.D/11272 |
Changed: 59c52
|
== Discussion == |
|
== Comments == |
Added: 60a54
|
Now that the D compiler features embedded documentation functionality ("Ddoc": D 1.x, D 2.x), there's probably not as much need for Doxygen to be modified to suit D, but it would still benefit D if Doxygen were more "D-compatible". |
Doxygen Issues
D support was added to Doxygen version 1.3.6, and was working even before that using "dfilter"
However, there are still a few problems with using Doxygen for creating D documentation.
Pending Patches
None for 1.4.3 so far
Left To Do
Tracker bug for D issues:
- http://bugzilla.gnome.org/show_bug.cgi?id=170235
- debug and version conditionals are not supported
- "alias" not working (should be in D mode)
- http://bugzilla.gnome.org/show_bug.cgi?id=172789
- /+ +/ comments are not recognized
- attribute blocks not supported
- "function" and "delegate" not working
- templates not supported
Missing Features
Automatic documentation for:
- Unit Tests
- Contracts
Workarounds
- dfilter can be used to preprocess .d source code
FILTER_PATTERNS = *.d=dfilter
- simple text changes, like the ones listed below
- the C/C++ preprocessor features of Doxygen can be abused to change text/words
- alias can be treated as "typedef"
Related Newsgroup Threads
- NG:digitalmars.D.announce/241 (dfilter program)
- NG:digitalmars.D.announce/99
- NG:digitalmars.D/18764
- NG:digitalmars.D/11272
Comments
Now that the D compiler features embedded documentation functionality ("Ddoc": D 1.x, D 2.x), there's probably not as much need for Doxygen to be modified to suit D, but it would still benefit D if Doxygen were more "D-compatible".