Hello Anders,
BCS wrote:
So if you want to ship headers as a form of documentation for your
library, you may want to find another way.
Yes: do it the traditional way as in C/C++.
You keep refuring to the header files as documentation but I can't
remember that last time I looked at someone else's .h file where I
didn't already consider something to be broken. If the only source of
info on how to use a library is the header files, I'll just use a
differnt lib or write my own, because IMHO they make for really bad
documentation.
HeaderDoc isn't that bad (like when compared to JavaDoc or something)
http://developer.apple.com/opensource/tools/headerdoc.html
For D (or alternatively) one could use Doxygen, or the built-in ddoc.
Something like http://wxd.sourceforge.net/api/index.html
I have no problems with the header files being the source for the documentation
files. What I'm saying is a bad thing is when the header file IS the documentation
file.
