ddoc

struct Example;

Example is a structure meant to demonstrate Ddoc documentation.

• 1
• 2
• 3

In addition to the first one-line short description, we can also write longer multi-line descriptions to expand on the object's functionality.

int a;

This integer is documented briefly.

int getY(int x);

This function has documented parameters.

We document all the parameters in a params section. The return value and exceptions can also be documented.

Params:

int x

The x coordinate

Returns:
The y coordinate

Throws:
Exception if x is negative.