Tables

Breathe has support for tables in the doxygen documentation. They are output as follows.

A simple Markdown syntax table

.. doxygenclass:: Table_1
   :project: tables

It renders as:


class Table_1

This is a simple Markdown table example.

Following is a simple table using Markdown syntax.

First Header

Second Header

Content Cell

Content Cell

Content Cell

Content Cell

And this is some more text.


A Markdown syntax table with alignment

.. doxygenclass:: Table_2
   :project: tables

It renders as:


class Table_2

This is a Markdown table with alignment.

Following is a table with alignment using Markdown syntax.

Right

Center

Left

10

10

10

1000

1000

1000

And this is some more text.


A Markdown syntax table with rowspan (and alignment)

.. doxygenclass:: Table_3
   :project: tables

It renders as:


class Table_3

This is a Markdown table with rowspan and alignment.

Following is a table with rowspan and alignment using Markdown syntax.

Right

Center

Left

10

10

10

^

1000

1000

And this is some more text.


A Markdown syntax table with colspan (and alignment)

.. doxygenclass:: Table_4
   :project: tables

It renders as:


class Table_4

This is a Markdown table with colspan and alignment.

Following is a table with colspan and alignment using Markdown syntax.

Right

Center

Left

10

10

10

1000

And this is some more text.


A Doxygen syntax table

.. doxygenclass:: Table_5
   :project: tables

It renders as:


class Table_5

This is a Doxygen table.

Following is a table using Doxygen syntax (and all supported features).

Column 1

Column 2

Column 3

cell row=1+2,col=1

cell row=1,col=2

cell row=1,col=3

cell row=2+3,col=2

cell row=2,col=3

cell row=3,col=1

cell row=3+4,col=3

cell row=4,col=1+2

cell row=5,col=1

cell row=5,col=2+3

cell row=6+7,col=1+2

cell row=6,col=3

cell row=7,col=3

cell row=8,col=1

cell row=8,col=2

Inner cell row=1,col=1

Inner cell row=1,col=2

Inner cell row=2,col=1

Inner cell row=2,col=2

cell row=8,col=3

  • Item 1

  • Item 2

And this is some more text.