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.
Comment #1 by shro8822 — 2007-10-11T21:42:28Z
Take a look at the Phobos source. IIRC it has many examples
Comment #2 by wbaxter — 2007-10-11T21:53:21Z
Thanks. I know it does. The point of filing the bug report is to make life easier for future users so they don't have to go digging through the phobos source just to find out how to make some text bold.
Comment #3 by shro8822 — 2007-10-11T23:00:20Z
I hear you. I was proposing a work around, not a solution.
Comment #4 by andrej.mitrovich — 2014-04-23T18:25:09Z