Doxygenは、ドキュメントにテーブルを挿入するための2つの方法をサポートしています。
最も簡単な方法は、Markdown拡張機能セクションのテーブルで示されているように、Markdown形式を使用することです。
この形式は使いやすく読みやすいですが、かなり制限されています。各セルが単一行のプレーンテキストである、単純なセルのグリッドのみをサポートしています。
より複雑なテーブルにはHTML構文を使用できます。Doxygenは、そのようなテーブルを処理し、様々な出力形式(少なくともHTMLやなど、テーブルをサポートする形式の場合)に変換します。
注意:テーブルは少なくとも1つの行(<tr>)を含み、<caption>を使用する場合は、<caption>は最初の行の前に置く必要があります。
複雑なテーブルの例を以下に示します
<table> <caption id="multi_row">Complex table</caption> <tr><th>Column 1 <th>Column 2 <th>Column 3 <tr><td rowspan="2">cell row=1+2,col=1<td>cell row=1,col=2<td>cell row=1,col=3 <tr><td rowspan="2">cell row=2+3,col=2 <td>cell row=2,col=3 <tr><td>cell row=3,col=1 <td rowspan="2">cell row=3+4,col=3 <tr><td colspan="2">cell row=4,col=1+2 <tr><td>cell row=5,col=1 <td colspan="2">cell row=5,col=2+3 <tr><td colspan="2" rowspan="2">cell row=6+7,col=1+2 <td>cell row=6,col=3 <tr> <td>cell row=7,col=3 <tr><td>cell row=8,col=1 <td>cell row=8,col=2\n <table> <tr><td>Inner cell row=1,col=1<td>Inner cell row=1,col=2 <tr><td>Inner cell row=2,col=1<td>Inner cell row=2,col=2 </table> <td>cell row=8,col=3 <ul> <li>Item 1 <li>Item 2 </ul> </table>
これには、キャプション、テーブルヘッダー、様々な行および列スパン、セルの一つとしてのネストされたテーブル、および別のセル内の項目リストが含まれています。
上記の例では、終了タグ(</td>など)が省略されていることに注意してください。これは許可されており、HTML出力ではDoxygenが終了タグを再度追加します。
出力は以下のようになります
列1 | 列2 | 列3 | ||||
---|---|---|---|---|---|---|
セル 行=1+2,列=1 | セル 行=1,列=2 | セル 行=1,列=3 | ||||
セル 行=2+3,列=2 | セル 行=2,列=3 | |||||
セル 行=3,列=1 | セル 行=3+4,列=3 | |||||
セル 行=4,列=1+2 | ||||||
セル 行=5,列=1 | セル 行=5,列=2+3 | |||||
セル 行=6+7,列=1+2 | セル 行=6,列=3 | |||||
セル 行=7,列=3 | ||||||
セル 行=8,列=1 | セル 行=8,列=2
| セル 行=8,列=3
|
テーブルのキャプションは、キャプションのIDをラベルとして使用し、\refを使って参照できます。