[Issue 1574] New: DDoc documentation lacks macro examples

[d-bugmail at puremagic.com]

http://d.puremagic.com/issues/show_bug.cgi?id=1574

           Summary: DDoc documentation lacks macro examples
           Product: D
           Version: unspecified
          Platform: PC
        OS/Version: Windows
            Status: NEW
          Severity: enhancement
          Priority: P2
         Component: www.digitalmars.com
        AssignedTo: bugzilla at digitalmars.com
        ReportedBy: wbaxter at gmail.com


There isn't a single example of how to actually use a macro on the ddoc
instructions pages (http://www.digitalmars.com/d/ddoc.html ;
http://www.digitalmars.com/d/1.0/ddoc.html)

Theres some verbose description of how macros can have arguments blah blah
blah, but it should be followed by an example like:

"""
For example, to use the predefined bold formatting macro, B:
/** A function of some sort.
 *
 *  After calling this, you $(B absolutely must) remember to brush your teeth.
 */
"""

... at least after reading the description a few times I $(I think) that's how
DDoc macros are supposted to be used.


--