On 24/10/2009 01:56, Simen Kjaeraas wrote:
Yigal Chripun <[email protected]> wrote:
On 22/10/2009 18:52, BCS wrote:
I'm cynical enough that I'd bet if D switches to a "smarter lib format"
a lot of people would manage to forget the documentation.
With the current system, the library must be shipped with, at a minimum,
a human readable list of prototypes.
without proper documentation people will have no way to know how to
use such libraries. given that D has DDoc to automate this process I'd
say it'll encourage developers to provide proper documentation instead
of just saying - go read the headers/source.
Wild ideas to make people document code:
1) Make DDoc generation the default, turn off by command line switch.
2) Issue a warning (or even error) when a public function is uncommented.
--
Simen
that's too much I think.
DDoc should be separated from the compiler and just use the compiler's
XML/Json output to generate documentation.
Such a separate DDoc program can issue documentation warnings (just like
doxygen can).
