Last update January 24, 2008

Doxygen Issues

Difference (last change) (Author, normal page display)

Changed: 54c54

Now that the D compiler features embedded documentation functionality (

Ddoc), 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".

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

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.

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".