Library standardization

Bill Baxter dnewsgroup at billbaxter.com
Sun Apr 20 22:29:18 PDT 2008


Walter Bright wrote:
> e-t172 wrote:
>> - Like you said, indentation is stripped. This make .di files quite 
>> ugly. Considering that .di files will often be directly read by the 
>> user of the API, this is a problem.
> 
> The .di files are meant for the compiler to read, not the user. They're 
> supposed to strip out all the extra whitespace and comments. Think of 
> them as "precompiled headers."
> 
> 
>> - There should be some kind of feature to automatically copy the 
>> "documentation comments" (ddoc, doxygen, etc) from the .d files to the 
>> .di files when they are generated. A solution would be to 
>> automatically include all comments which are not in implementation code.
> 
> The human-readable form is the ddoc output.

I find it much easier to open up a header file in my text editor to 
search for the functions I'm looking.
Easier than it is to go over to my browser and hope that the 
documentation exists and is complete.
I can also run grep on files easily from within my editor to search for 
patterns in text files.  My browser can't do that.

But maybe ddoc could be enhanced to
1) generate doc stubs for *all* public memebers, not just the ones the 
author remembered to document.
2) generate plain text .d files with just doc comments and function 
signatures etc.

But I think it would be easier to make -H generate nice output than 
doing those two.

--bb



More information about the Digitalmars-d mailing list