current ddoc state of the art

Walter Bright via Digitalmars-d digitalmars-d at puremagic.com
Thu Jan 1 12:48:58 PST 2015


On 1/1/2015 10:04 AM, Dicebot wrote:
> As long as you are actually forced to use _any_ kind of macros in basic
> documentation it won't be good enough.


Basic documentation can be written without any macros:


/****************************
This function does blah, blah, blah.

Blah, blah, blah is an amazing algorithm invented by I. M. Nerdly.

Params:
    x = the awesome input value

Returns:
    insightful description of the return value

Example:
---
int foo(int x) { ... stunning D code ... }
---
***************************/

Can you do lists without macros in Ddoc? Sure:

/**************************************

  Description

  1. first item

  2. second item

An unordered list:

  - first item

  - second item

**********************************/


More information about the Digitalmars-d mailing list