Basic formatting
[MicoleLib documentation]

Collaboration diagram for Basic formatting:

Introduction

This page demonstrated some of the basic formatting options available in the template.

Formatting is applied using various Doxygen commands (all preceeded by a \) and embedded html blocks.

In the following sections you can see how various formatting element are applied.

Sections

Sections can be used to split the documentation into logical blocks. Each section has a title and an anchor. Other documentation can link to a section by using the \ref Doxygen command. Doxygen currently supports 3 levels of sections.

Main sections of a document are "foldable" to allow you get a quick overview of the document's structure.

Main sections (1st. level) are created with the \section command.

Sub-section #1

Sub-sections (2nd. level are created with the \subsection command.

Sub-sub-section #1.1

Sub-sub-sections (3rd. level) are created with the \subsubsection command.

Sub-sub-section #2.2

Multiple sub-sub-sections can be grouped inside a sub-section.

Sub-section #2

Sub-section text for Sub-section #2 goes here.

Block elements

You can create multiple paragraphs using the p tag.

Tables

You can create tables using the table,tr, th, and td html tags.

Heading 1	Heading 2	Heading 3
Data11	Data12	Data13
Data21	Data22	Data23
Data31	Data32	Data33

Lists

Doxygen allows you to create various kinds of lists in your documentation.

Definition lists

You can use the dl, dt and dd tags to create definition lists.

Term 1

Description of Term 1 here.

Term 2

Description of Term 2 here.

Term 3

Description of Term 3 here.

Unordered list

You can use the ul and li tags to create unordered lists.

• Item 1
• Item 2
• Item 3

Ordered list

You can use the ol and li tags to create unordered lists.

1. Item 1
2. Item 2
3. Item 3

Lines

You can use the hr tag to create horizontal rulers (hr does not need to be followed by a closing tag).

---

Inline styles

You can use inline styles to format individual text elements:

Tag	Description
i	Use the i tag to create italics text.
b	Use the b tag to create bold text.
code	Use the code tag to create mono-space text.
br	Use the br tag to create aline break. Note that this tag does not need to be followed by a closing br tag.

---