Improving ddoc

Jacob Carlborg via Digitalmars-d digitalmars-d at puremagic.com
Fri Jan 2 02:34:33 PST 2015


On 2015-01-02 10:40, Andrei Alexandrescu wrote:

>> * A list of summary with all symbols should be automatically generated
>> for a module
>
> Shouldn't we leave that to postprocessing?

No, why would we do that? I want be able to easily generate good 
documentation. If something requires an extra step to make it better it 
will not be as easy.

I also think it will be easier for Ddoc to do this than doing it in a 
postprocess step:

* Ddoc will already have all the information available

* The postprocessing tool will need to parse the output to get this 
information

* If Ddoc is supposed to be designed for multiple output formats the 
postprocessing tool need to be able to handle that as well.

Also, it should be possible to disable this if it's not desired.

>> * A nice tree view with all packages and modules with filter for all
>> symbols
>
> This seems like a matter of styling, not functionality.

I don't see how this can be a matter of styling if it should support 
filtering.

I'm thinking of something like the Scala documentation I linked to [1]. 
It has something more like a flat list with different sections. It 
doesn't matter if you call it styling of functionality ;) I still would 
like to see it in the default output.

[1] http://www.scala-lang.org/api/current/#scala.collection.Iterable

-- 
/Jacob Carlborg


More information about the Digitalmars-d mailing list