vnfs/VES5.0/doxygen-1.8.12/html/tables.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <meta name="generator" content="Doxygen 1.8.12"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>Doxygen: Including tables</title>
   9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10 <script type="text/javascript" src="jquery.js"></script>
  11 <script type="text/javascript" src="dynsections.js"></script>
  12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  13 <script type="text/javascript" src="resize.js"></script>
  14 <script type="text/javascript" src="navtreedata.js"></script>
  15 <script type="text/javascript" src="navtree.js"></script>
  16 <script type="text/javascript">
  17   $(document).ready(initResizable);
  18 </script>
  19 <link href="doxygen_manual.css" rel="stylesheet" type="text/css" />
  20 </head>
  21 <body>
  22 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  23 <div id="titlearea">
  24 <table cellspacing="0" cellpadding="0">
  25  <tbody>
  26  <tr style="height: 56px;">
  27   <td id="projectalign" style="padding-left: 0.5em;">
  28    <div id="projectname">Doxygen
  29    </div>
  30   </td>
  31  </tr>
  32  </tbody>
  33 </table>
  34 </div>
  35 <!-- end header part -->
  36 <!-- Generated by Doxygen 1.8.12 -->
  37 </div><!-- top -->
  38 <div id="side-nav" class="ui-resizable side-nav-resizable">
  39   <div id="nav-tree">
  40     <div id="nav-tree-contents">
  41       <div id="nav-sync" class="sync"></div>
  42     </div>
  43   </div>
  44   <div id="splitbar" style="-moz-user-select:none;"
  45        class="ui-resizable-handle">
  46   </div>
  47 </div>
  48 <script type="text/javascript">
  49 $(document).ready(function(){initNavTree('tables.html','');});
  50 </script>
  51 <div id="doc-content">
  52 <div class="header">
  53   <div class="headertitle">
  54 <div class="title">Including tables </div>  </div>
  55 </div><!--header-->
  56 <div class="contents">
  57 <div class="textblock"><p>Doxygen supports two ways to put tables in the documentation.</p>
  58 <p>The easiest is to use the Markdown format as shown in <a class="el" href="markdown.html#markdown_extra">Markdown Extensions</a> section <a class="el" href="markdown.html#md_tables">Tables</a>.</p>
  59 <p>Although this format is easy to use and read, it is also rather limited. It supports only a simple grid of cells, while each cell is a single line of plain text.</p>
  60 <p>For more complex tables the HTML syntax can be used. Doxygen will process such tables and translate them to the various output formats (at least for the formats that do support tables such as HTML and <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"/>).</p>
  61 <p>Here is an example of a complex table:</p>
  62 <pre class="fragment">&lt;table&gt;
  63 &lt;caption id="multi_row"&gt;Complex table&lt;/caption&gt;
  64 &lt;tr&gt;&lt;th&gt;Column 1                      &lt;th&gt;Column 2        &lt;th&gt;Column 3
  65 &lt;tr&gt;&lt;td rowspan="2"&gt;cell row=1+2,col=1&lt;td&gt;cell row=1,col=2&lt;td&gt;cell row=1,col=3
  66 &lt;tr&gt;&lt;td rowspan="2"&gt;cell row=2+3,col=2                    &lt;td&gt;cell row=2,col=3
  67 &lt;tr&gt;&lt;td&gt;cell row=3,col=1                                  &lt;td rowspan="2"&gt;cell row=3+4,col=3
  68 &lt;tr&gt;&lt;td colspan="2"&gt;cell row=4,col=1+2
  69 &lt;tr&gt;&lt;td&gt;cell row=5,col=1              &lt;td colspan="2"&gt;cell row=5,col=2+3
  70 &lt;tr&gt;&lt;td colspan="2" rowspan="2"&gt;cell row=6+7,col=1+2      &lt;td&gt;cell row=6,col=3
  71 &lt;tr&gt;                                                      &lt;td&gt;cell row=7,col=3
  72 &lt;tr&gt;&lt;td&gt;cell row=8,col=1              &lt;td&gt;cell row=8,col=2\n
  73   &lt;table&gt;
  74     &lt;tr&gt;&lt;td&gt;Inner cell row=1,col=1&lt;td&gt;Inner cell row=1,col=2
  75     &lt;tr&gt;&lt;td&gt;Inner cell row=2,col=1&lt;td&gt;Inner cell row=2,col=2
  76   &lt;/table&gt;
  77   &lt;td&gt;cell row=8,col=3
  78   &lt;ul&gt;
  79     &lt;li&gt;Item 1
  80     &lt;li&gt;Item 2
  81   &lt;/ul&gt;
  82 &lt;/table&gt;
  83 </pre><p>It has a caption, table heading, various row and column spans, a nested table as one of the cells, and a item list in another cell.</p>
  84 <p>Note that the end tags (like <code>&lt;/td&gt;</code>) are left out in the example above. This is allowed, and in the HTML output doxygen will add the end tags again.</p>
  85 <p>The output will look as follows:</p>
  86 <a class="anchor" id="multi_row"></a>
  87 <table class="doxtable">
  88 <caption>Complex table</caption>
  89 <tr>
  90 <th>Column 1 </th><th>Column 2 </th><th>Column 3 </th></tr>
  91 <tr>
  92 <td rowspan="2">cell row=1+2,col=1</td><td>cell row=1,col=2</td><td>cell row=1,col=3 </td></tr>
  93 <tr>
  94 <td rowspan="2">cell row=2+3,col=2 </td><td>cell row=2,col=3 </td></tr>
  95 <tr>
  96 <td>cell row=3,col=1 </td><td rowspan="2">cell row=3+4,col=3 </td></tr>
  97 <tr>
  98 <td colspan="2">cell row=4,col=1+2 </td></tr>
  99 <tr>
 100 <td>cell row=5,col=1 </td><td colspan="2">cell row=5,col=2+3 </td></tr>
 101 <tr>
 102 <td colspan="2" rowspan="2">cell row=6+7,col=1+2 </td><td>cell row=6,col=3 </td></tr>
 103 <tr>
 104 <td>cell row=7,col=3 </td></tr>
 105 <tr>
 106 <td>cell row=8,col=1 </td><td>cell row=8,col=2<br />
 107  <table class="doxtable">
 108 <tr>
 109 <td>Inner cell row=1,col=1</td><td>Inner cell row=1,col=2 </td></tr>
 110 <tr>
 111 <td>Inner cell row=2,col=1</td><td>Inner cell row=2,col=2 </td></tr>
 112 </table>
 113 </td><td>cell row=8,col=3 <ul>
 114 <li>
 115 Item 1 </li>
 116 <li>
 117 Item 2 </li>
 118 </ul>
 119 </td></tr>
 120 </table>
 121 <p>One can refer to the caption of the table using <a class="el" href="commands.html#cmdref">\ref</a> using the caption's id as the label.</p>
 122 <p>
 123 Go to the <a href="diagrams.html">next</a> section or return to the
 124  <a href="index.html">index</a>.
 125  </p>
 126 </div></div><!-- contents -->
 127 </div><!-- doc-content -->
 128 <!-- start footer part -->
 129 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 130   <ul>
 131     <li class="footer">Generated by
 132     <a href="http://www.doxygen.org/index.html">
 133     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.12 </li>
 134   </ul>
 135 </div>
 136 </body>
 137 </html>