Documentation Layout

[Matt Peterson]

On Wednesday, 28 March 2012 at 07:00:58 UTC, Brad Anderson wrote:
> [...]
> I've been trying to generate parsable ddoc output for use in an
> autocomplete for the search box (symbol names + short 
> documentation
> excerpts for context).  I had some luck but couldn't strip it 
> down to the
> bare minimum information I wanted to extract so I got it in my 
> head that I
> should try adding documentation to dmd's json output instead.  
> I haven't
> attempted this yet.  I think the search is very important.  
> Right now
> someone basically has to tell you where which module certain
> structs/classes are in std.typecons has a lot of useful stuff 
> but nobody
> would ever think to check there to find out where tuples or 
> RefCounted are.
>  Just yesterday I was very confused about why the documentation 
> for
> 'recurrence' had gone missing but it turns out it's in 
> std.range, not
> std.algorithm.
> [...]

As long as normal documentation output is turned on, my Json 
improvements 
(https://github.com/D-Programming-Language/dmd/pull/813) will 
output the (unformatted) documentation comments associated with 
all top-level declarations. Take a look at that.