current ddoc state of the art

Walter Bright via Digitalmars-d digitalmars-d at puremagic.com
Thu Jan 1 14:10:43 PST 2015


On 1/1/2015 1:49 PM, H. S. Teoh via Digitalmars-d wrote:
> The problem is that this is strictly speaking a hack, not a solution,
> because in the output it's not tagged as a list. This may not be a
> problem if the output is HTML for user consumption, but if you're
> outputting to XML, say, or if your HTML is postprocessed by semantic
> analysis tools, they will fail to pick up on the fact that this is a
> list.

I know it's not tagged as a list, but it does show up in the browser as a 
reasonable list.

The thing is, basic documentation can be done in Ddoc without using any macros - 
lists are not used in the vast majority of function descriptions. Using:

   $(LIST
      item1,
      item2,
      item3
    )

for the occasional use is simply not that heinous. Lists can also be styled in 
quite a variety of ways; with a special syntax for them they can only be styled 
one way across the entire document. It turns out that Ddoc usage has leaned 
towards using a lot of custom styling, because it's easy to do.


More information about the Digitalmars-d mailing list