# Doc block formatting tips
ApiGenerator uses MarkDown for parsing the contents of doc blocks. This provides you with a number of formatting options. In addition to regular markdown there are some ApiGenerator specific guidelines for making line breaks inside @tags.
### MarkDown Syntax
While ApiGenerator supports all normal MarkDown syntax it is not recommended that you use all formatting in your doc blocks.
#### Bold
Bold is indicated by 2 *'s on either side of the text. ex. `**I'm bold**`
#### Italic
Italic is indicated by one _underscore_ on either side of the text ex. `_italic_`
#### Preformatted text
Inline code is created by wrapping with equal number of backticks on both sides. You can use mulitple backticks to enclose text that contains backticks. Ex `` `inline code` ``
#### Headings
It is suggested that you only use H3 and H4 in your docblocks.
#### Lists
Bullets are created by starting a line with either -, +, or *. Nested lists can be achieved by indenting bullets with spaces.
{{{
- list
- level two
- level one
}}}
Creates:
- list
- level two
- level one
#### Code blocks
Code blocks are created with triple braces.
### Continuing Lines in @tags
Continuing lines in @tags can be done by using 1-3 spaces or 1 tab. An example would be
{{{
@param mixed $Model This is some example text
\s\s\sThis is indented with 3 spaces.
}}}
{{{
@param mixed $Model This is some example text
\tThis is indented with 1 tab.
}}}
### Class + Method reference links
If you want to reference other classes + methods just use a static method syntax ex. `Controller::render()` will create a link to the Controller class' link method. Class names are checked against the index but method names are not.
