表の挿入

Doxygen では、ドキュメントに表を挿入する方法が 2 つあります。

最も簡単な方法は、Markdown 拡張セクションので示されているように、Markdown 形式を使用することです。

この形式は使いやすく読みやすいですが、かなり制限もあります。単純なセルのグリッドのみをサポートし、各セルはプレーンテキストの 1 行のみです。

より複雑な表の場合は、HTML 構文を使用できます。Doxygen はそのような表を処理し、さまざまな出力形式(少なくとも HTML や {\LaTeX} など、表をサポートする形式の場合)に変換します。

表には少なくとも 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>

これには、キャプション、テーブル見出し、さまざまな行と列のスパン、セルの 1 つとしてのネストされたテーブル、および別のセル内の項目リストがあります。

上記の例では、終了タグ (</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
内側のセル 行=1, 列=1内側のセル 行=1, 列=2
内側のセル 行=2, 列=1内側のセル 行=2, 列=2
セル 行=8, 列=3
  • 項目 1
  • 項目 2

テーブルのキャプションを参照するには、キャプションの ID をラベルとして使用して \ref を使用できます。

次のセクションに進むか、インデックスに戻ります。