Removing D embedded in HTML feature
Bill Baxter
dnewsgroup at billbaxter.com
Thu Apr 10 23:12:19 PDT 2008
Robert Fraser wrote:
> Jim Hewes wrote:
>> 4. I didn't suggest UML. I just want to add vector diagrams, drawings,
>> flowcharts, links and other forms of visual documentation. I want to
>> edit them and keep them together with the source. Sure I can use
>> Doxygen to add @param and @returns in the source. But then when I look
>> at the source, I see the ugly @param and @returns. If I want to see
>> nice formatting, I need to go look at the HTML output which is whole
>> separate thing. And then when I'm looking at the HTML output in the
>> browser, I can't edit code there. Why can't it be together?
>
> That's one of the goals of DDoc -- to be (generally) human-readable
> without a lot of formatting. Not sure how successful it is at that, but
> I think it's a step up from Doxygen and Javadoc:
>
> http://www.digitalmars.com/d/2.0/ddoc.html
ReST and NaturalDocs contain some nice ideas for human-readable docs.
http://docutils.sourceforge.net/rst.html
http://www.naturaldocs.org/
The $(...) macros in DDoc aren't particularly human-friendly in my opinion.
--bb
More information about the Digitalmars-d
mailing list