mirror of https://github.com/swig/swig
Reformat tag lists in doxygen documentation
Reformat the tables of unsupported and ignored tags. Previous table format was not maintainable. Changing to use multi-column lists, so that entries can be easily sorted and updated. The displayed order is now by row instead of by column, which is decidedly easier to read. Other than removing duplicates, no change to content.
This commit is contained in:
John McFarland
parent
08ff05c14c
commit
1ac371369e
|
|
@ -829,155 +829,107 @@ These are suppressed with their content just printed out (if the tag has any
|
|||
sense, typically text content).
|
||||
Here is the list of these tags:
|
||||
</p>
|
||||
|
||||
<div class="diagram">
|
||||
<table border="0" summary="Unsupported Java Doxygen Tags">
|
||||
<tr>
|
||||
<th align="left">Unsupported Doxygen tags</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\addindex</td>
|
||||
<td>\addtogroup</td>
|
||||
<td>\anchor</td>
|
||||
<td>\attention</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\brief</td>
|
||||
<td>\bug</td>
|
||||
<td>\callgraph</td>
|
||||
<td>\callergraph</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\class</td>
|
||||
<td>\copybrief</td>
|
||||
<td>\copydetails</td>
|
||||
<td>\copydoc</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\date</td>
|
||||
<td>\def</td>
|
||||
<td>\defgroup</td>
|
||||
<td>\details</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\dir</td>
|
||||
<td>\dontinclude</td>
|
||||
<td>\dot</td>
|
||||
<td>\dotfile</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\enddot</td>
|
||||
<td>\endhtmlonly</td>
|
||||
<td>\endinternal</td>
|
||||
<td>\endlatexonly</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\endmanonly</td>
|
||||
<td>\endmsc</td>
|
||||
<td>\endrtfonly</td>
|
||||
<td>\endxmlonly</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\enum</td>
|
||||
<td>\example</td>
|
||||
<td>\extends</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\file</td>
|
||||
<td>\fn</td>
|
||||
<td>\headerfile</td>
|
||||
<td>\hideinitializer</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\htmlinclude</td>
|
||||
<td>\htmlonly</td>
|
||||
<td>\implements</td>
|
||||
<td>\include</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\includelineno</td>
|
||||
<td>\ingroup</td>
|
||||
<td>\internal</td>
|
||||
<td>\invariant</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\interface</td>
|
||||
<td>\latexonly</td>
|
||||
<td>\line</td>
|
||||
<td>\mainpage</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\manonly</td>
|
||||
<td>\memberof</td>
|
||||
<td>\msc</td>
|
||||
<td>\mscfile</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\name</td>
|
||||
<td>\namespace</td>
|
||||
<td>\nosubgrouping</td>
|
||||
<td>\package</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\page</td>
|
||||
<td>\paragraph</td>
|
||||
<td>\post</td>
|
||||
<td>\pre</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\private</td>
|
||||
<td>\privatesection</td>
|
||||
<td>\property</td>
|
||||
<td>\protected</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\protectedsection</td>
|
||||
<td>\protocol</td>
|
||||
<td>\public</td>
|
||||
<td>\publicsection</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\ref</td>
|
||||
<td>\related</td>
|
||||
<td>\relates</td>
|
||||
<td>\relatedalso</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\relatesalso</td>
|
||||
<td>\retval</td>
|
||||
<td>\rtfonly</td>
|
||||
<td>\section</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\short</td>
|
||||
<td>\showinitializer</td>
|
||||
<td>\skip</td>
|
||||
<td>\skipline</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\snippet</td>
|
||||
<td>\struct</td>
|
||||
<td>\subpage</td>
|
||||
<td>\subsection</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\subsubsection</td>
|
||||
<td>\tableofcontents</td>
|
||||
<td>\test</td>
|
||||
<td>\typedef</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\union</td>
|
||||
<td>\until</td>
|
||||
<td>\var</td>
|
||||
<td>\verbinclude</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\weakgroup</td>
|
||||
<td>\xmlonly</td>
|
||||
<td>\xrefitem</td>
|
||||
<td>\category</td>
|
||||
</tr>
|
||||
</table>
|
||||
<b>Unsupported Doxygen tags</b>
|
||||
|
||||
<ul style="list-style-type:none;column-count:4;">
|
||||
<li>\addindex</li>
|
||||
<li>\addtogroup</li>
|
||||
<li>\anchor</li>
|
||||
<li>\attention</li>
|
||||
<li>\brief</li>
|
||||
<li>\bug</li>
|
||||
<li>\callergraph</li>
|
||||
<li>\callgraph</li>
|
||||
<li>\category</li>
|
||||
<li>\class</li>
|
||||
<li>\copybrief</li>
|
||||
<li>\copydetails</li>
|
||||
<li>\copydoc</li>
|
||||
<li>\date</li>
|
||||
<li>\def</li>
|
||||
<li>\defgroup</li>
|
||||
<li>\details</li>
|
||||
<li>\dir</li>
|
||||
<li>\dontinclude</li>
|
||||
<li>\dot</li>
|
||||
<li>\dotfile</li>
|
||||
<li>\enddot</li>
|
||||
<li>\endhtmlonly</li>
|
||||
<li>\endinternal</li>
|
||||
<li>\endlatexonly</li>
|
||||
<li>\endmanonly</li>
|
||||
<li>\endmsc</li>
|
||||
<li>\endrtfonly</li>
|
||||
<li>\endxmlonly</li>
|
||||
<li>\enum</li>
|
||||
<li>\example</li>
|
||||
<li>\extends</li>
|
||||
<li>\file</li>
|
||||
<li>\fn</li>
|
||||
<li>\headerfile</li>
|
||||
<li>\hideinitializer</li>
|
||||
<li>\htmlinclude</li>
|
||||
<li>\htmlonly</li>
|
||||
<li>\implements</li>
|
||||
<li>\include</li>
|
||||
<li>\includelineno</li>
|
||||
<li>\ingroup</li>
|
||||
<li>\interface</li>
|
||||
<li>\internal</li>
|
||||
<li>\invariant</li>
|
||||
<li>\latexonly</li>
|
||||
<li>\line</li>
|
||||
<li>\mainpage</li>
|
||||
<li>\manonly</li>
|
||||
<li>\memberof</li>
|
||||
<li>\msc</li>
|
||||
<li>\mscfile</li>
|
||||
<li>\name</li>
|
||||
<li>\namespace</li>
|
||||
<li>\nosubgrouping</li>
|
||||
<li>\package</li>
|
||||
<li>\page</li>
|
||||
<li>\paragraph</li>
|
||||
<li>\post</li>
|
||||
<li>\pre</li>
|
||||
<li>\private</li>
|
||||
<li>\privatesection</li>
|
||||
<li>\property</li>
|
||||
<li>\protected</li>
|
||||
<li>\protectedsection</li>
|
||||
<li>\protocol</li>
|
||||
<li>\public</li>
|
||||
<li>\publicsection</li>
|
||||
<li>\ref</li>
|
||||
<li>\related</li>
|
||||
<li>\relatedalso</li>
|
||||
<li>\relates</li>
|
||||
<li>\relatesalso</li>
|
||||
<li>\retval</li>
|
||||
<li>\rtfonly</li>
|
||||
<li>\section</li>
|
||||
<li>\short</li>
|
||||
<li>\showinitializer</li>
|
||||
<li>\skip</li>
|
||||
<li>\skipline</li>
|
||||
<li>\snippet</li>
|
||||
<li>\struct</li>
|
||||
<li>\subpage</li>
|
||||
<li>\subsection</li>
|
||||
<li>\subsubsection</li>
|
||||
<li>\tableofcontents</li>
|
||||
<li>\test</li>
|
||||
<li>\typedef</li>
|
||||
<li>\union</li>
|
||||
<li>\until</li>
|
||||
<li>\var</li>
|
||||
<li>\verbinclude</li>
|
||||
<li>\weakgroup</li>
|
||||
<li>\xmlonly</li>
|
||||
<li>\xrefitem</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<p>
|
||||
|
|
@ -987,68 +939,47 @@ comment, the whole comment block is ignored:
|
|||
<!-- see parser.y, function isStructuralDoxygen() -->
|
||||
|
||||
</p>
|
||||
<div class="diagram">
|
||||
<table border="0" summary="Ignored Java Doxygen Tags">
|
||||
<tr>
|
||||
<th align="left">Ignored Doxygen tags</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\addtogroup</td>
|
||||
<td>\callgraph</td>
|
||||
<td>\callergraph</td>
|
||||
<td>\category</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\class</td>
|
||||
<td>\def</td>
|
||||
<td>\defgroup</td>
|
||||
<td>\dir</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\enum</td>
|
||||
<td>\example</td>
|
||||
<td>\file</td>
|
||||
<td>\fn</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\headerfile</td>
|
||||
<td>\hideinitializer</td>
|
||||
<td>\interface</td>
|
||||
<td>\internal</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\mainpage</td>
|
||||
<td>\name</td>
|
||||
<td>\namespace</td>
|
||||
<td>\nosubgrouping</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\overload</td>
|
||||
<td>\package</td>
|
||||
<td>\page</td>
|
||||
<td>\property</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\protocol</td>
|
||||
<td>\relates</td>
|
||||
<td>\relatesalso</td>
|
||||
<td>\showinitializer</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\struct</td>
|
||||
<td>\name</td>
|
||||
<td>\namespace</td>
|
||||
<td>\nosubgrouping</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\typedef</td>
|
||||
<td>\union</td>
|
||||
<td>\var</td>
|
||||
<td>\weakgroup</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
<div class="diagram">
|
||||
<b>Ignored Doxygen tags</b>
|
||||
|
||||
<ul style="list-style-type:none;column-count:4;">
|
||||
<li>\addtogroup</li>
|
||||
<li>\callergraph</li>
|
||||
<li>\callgraph</li>
|
||||
<li>\category</li>
|
||||
<li>\class</li>
|
||||
<li>\def</li>
|
||||
<li>\defgroup</li>
|
||||
<li>\dir</li>
|
||||
<li>\enum</li>
|
||||
<li>\example</li>
|
||||
<li>\file</li>
|
||||
<li>\fn</li>
|
||||
<li>\headerfile</li>
|
||||
<li>\hideinitializer</li>
|
||||
<li>\interface</li>
|
||||
<li>\internal</li>
|
||||
<li>\mainpage</li>
|
||||
<li>\name</li>
|
||||
<li>\namespace</li>
|
||||
<li>\nosubgrouping</li>
|
||||
<li>\overload</li>
|
||||
<li>\package</li>
|
||||
<li>\page</li>
|
||||
<li>\property</li>
|
||||
<li>\protocol</li>
|
||||
<li>\relates</li>
|
||||
<li>\relatesalso</li>
|
||||
<li>\showinitializer</li>
|
||||
<li>\struct</li>
|
||||
<li>\typedef</li>
|
||||
<li>\union</li>
|
||||
<li>\var</li>
|
||||
<li>\weakgroup</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -1458,177 +1389,121 @@ are suppressed with their content just printed out (if it has any
|
|||
sense, typically text content).
|
||||
Here is the list of these tags:
|
||||
</p>
|
||||
|
||||
<div class="diagram">
|
||||
<table border="0" summary="Unsupported Python Doxygen Tags">
|
||||
<tr>
|
||||
<th align="left">Unsupported Doxygen tags</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\addindex</td>
|
||||
<td>\addtogroup</td>
|
||||
<td>\anchor</td>
|
||||
<td>\attention</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\brief</td>
|
||||
<td>\bug</td>
|
||||
<td>\callgraph</td>
|
||||
<td>\callergraph</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\class</td>
|
||||
<td>\copybrief</td>
|
||||
<td>\copydetails</td>
|
||||
<td>\copydoc</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\date</td>
|
||||
<td>\def</td>
|
||||
<td>\defgroup</td>
|
||||
<td>\details</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\dir</td>
|
||||
<td>\dontinclude</td>
|
||||
<td>\dot</td>
|
||||
<td>\dotfile</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\code</td>
|
||||
<td>\endcode</td>
|
||||
<td>\endverbatim</td>
|
||||
<td>\endlink</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\enddot</td>
|
||||
<td>\endhtmlonly</td>
|
||||
<td>\endinternal</td>
|
||||
<td>\endlatexonly</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\endmanonly</td>
|
||||
<td>\endmsc</td>
|
||||
<td>\endrtfonly</td>
|
||||
<td>\endxmlonly</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\enum</td>
|
||||
<td>\example</td>
|
||||
<td>\extends</td>
|
||||
<td>\f$</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\f[</td>
|
||||
<td>\f]</td>
|
||||
<td>\f{</td>
|
||||
<td>\f}</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\file</td>
|
||||
<td>\fn</td>
|
||||
<td>\headerfile</td>
|
||||
<td>\hideinitializer</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\htmlinclude</td>
|
||||
<td>\htmlonly</td>
|
||||
<td>\implements</td>
|
||||
<td>\include</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\image</td>
|
||||
<td>\link</td>
|
||||
<td>\verbatim</td>
|
||||
<td>\p</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\includelineno</td>
|
||||
<td>\ingroup</td>
|
||||
<td>\internal</td>
|
||||
<td>\invariant</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\interface</td>
|
||||
<td>\latexonly</td>
|
||||
<td>\line</td>
|
||||
<td>\mainpage</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\manonly</td>
|
||||
<td>\memberof</td>
|
||||
<td>\msc</td>
|
||||
<td>\mscfile</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\name</td>
|
||||
<td>\namespace</td>
|
||||
<td>\nosubgrouping</td>
|
||||
<td>\package</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\page</td>
|
||||
<td>\paragraph</td>
|
||||
<td>\post</td>
|
||||
<td>\pre</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\private</td>
|
||||
<td>\privatesection</td>
|
||||
<td>\property</td>
|
||||
<td>\protected</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\protectedsection</td>
|
||||
<td>\protocol</td>
|
||||
<td>\public</td>
|
||||
<td>\publicsection</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\ref</td>
|
||||
<td>\related</td>
|
||||
<td>\relates</td>
|
||||
<td>\relatedalso</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\relatesalso</td>
|
||||
<td>\retval</td>
|
||||
<td>\rtfonly</td>
|
||||
<td>\section</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\short</td>
|
||||
<td>\showinitializer</td>
|
||||
<td>\skip</td>
|
||||
<td>\skipline</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\snippet</td>
|
||||
<td>\struct</td>
|
||||
<td>\subpage</td>
|
||||
<td>\subsection</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\subsubsection</td>
|
||||
<td>\tableofcontents</td>
|
||||
<td>\test</td>
|
||||
<td>\typedef</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\union</td>
|
||||
<td>\until</td>
|
||||
<td>\var</td>
|
||||
<td>\verbinclude</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\weakgroup</td>
|
||||
<td>\xmlonly</td>
|
||||
<td>\xrefitem</td>
|
||||
<td>\category</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>\c</td>
|
||||
</tr>
|
||||
</table>
|
||||
<b>Unsupported Python Doxygen tags</b>
|
||||
|
||||
<ul style="list-style-type:none;column-count:4;">
|
||||
<li>\addindex</li>
|
||||
<li>\addtogroup</li>
|
||||
<li>\anchor</li>
|
||||
<li>\attention</li>
|
||||
<li>\brief</li>
|
||||
<li>\bug</li>
|
||||
<li>\c</li>
|
||||
<li>\callergraph</li>
|
||||
<li>\callgraph</li>
|
||||
<li>\category</li>
|
||||
<li>\class</li>
|
||||
<li>\code</li>
|
||||
<li>\copybrief</li>
|
||||
<li>\copydetails</li>
|
||||
<li>\copydoc</li>
|
||||
<li>\date</li>
|
||||
<li>\def</li>
|
||||
<li>\defgroup</li>
|
||||
<li>\details</li>
|
||||
<li>\dir</li>
|
||||
<li>\dontinclude</li>
|
||||
<li>\dot</li>
|
||||
<li>\dotfile</li>
|
||||
<li>\endcode</li>
|
||||
<li>\enddot</li>
|
||||
<li>\endhtmlonly</li>
|
||||
<li>\endinternal</li>
|
||||
<li>\endlatexonly</li>
|
||||
<li>\endlink</li>
|
||||
<li>\endmanonly</li>
|
||||
<li>\endmsc</li>
|
||||
<li>\endrtfonly</li>
|
||||
<li>\endverbatim</li>
|
||||
<li>\endxmlonly</li>
|
||||
<li>\enum</li>
|
||||
<li>\example</li>
|
||||
<li>\extends</li>
|
||||
<li>\f$</li>
|
||||
<li>\f[</li>
|
||||
<li>\f]</li>
|
||||
<li>\file</li>
|
||||
<li>\fn</li>
|
||||
<li>\f{</li>
|
||||
<li>\f}</li>
|
||||
<li>\headerfile</li>
|
||||
<li>\hideinitializer</li>
|
||||
<li>\htmlinclude</li>
|
||||
<li>\htmlonly</li>
|
||||
<li>\image</li>
|
||||
<li>\implements</li>
|
||||
<li>\include</li>
|
||||
<li>\includelineno</li>
|
||||
<li>\ingroup</li>
|
||||
<li>\interface</li>
|
||||
<li>\internal</li>
|
||||
<li>\invariant</li>
|
||||
<li>\latexonly</li>
|
||||
<li>\line</li>
|
||||
<li>\link</li>
|
||||
<li>\mainpage</li>
|
||||
<li>\manonly</li>
|
||||
<li>\memberof</li>
|
||||
<li>\msc</li>
|
||||
<li>\mscfile</li>
|
||||
<li>\name</li>
|
||||
<li>\namespace</li>
|
||||
<li>\nosubgrouping</li>
|
||||
<li>\p</li>
|
||||
<li>\package</li>
|
||||
<li>\page</li>
|
||||
<li>\paragraph</li>
|
||||
<li>\post</li>
|
||||
<li>\pre</li>
|
||||
<li>\private</li>
|
||||
<li>\privatesection</li>
|
||||
<li>\property</li>
|
||||
<li>\protected</li>
|
||||
<li>\protectedsection</li>
|
||||
<li>\protocol</li>
|
||||
<li>\public</li>
|
||||
<li>\publicsection</li>
|
||||
<li>\ref</li>
|
||||
<li>\related</li>
|
||||
<li>\relatedalso</li>
|
||||
<li>\relates</li>
|
||||
<li>\relatesalso</li>
|
||||
<li>\retval</li>
|
||||
<li>\rtfonly</li>
|
||||
<li>\section</li>
|
||||
<li>\short</li>
|
||||
<li>\showinitializer</li>
|
||||
<li>\skip</li>
|
||||
<li>\skipline</li>
|
||||
<li>\snippet</li>
|
||||
<li>\struct</li>
|
||||
<li>\subpage</li>
|
||||
<li>\subsection</li>
|
||||
<li>\subsubsection</li>
|
||||
<li>\tableofcontents</li>
|
||||
<li>\test</li>
|
||||
<li>\typedef</li>
|
||||
<li>\union</li>
|
||||
<li>\until</li>
|
||||
<li>\var</li>
|
||||
<li>\verbatim</li>
|
||||
<li>\verbinclude</li>
|
||||
<li>\weakgroup</li>
|
||||
<li>\xmlonly</li>
|
||||
<li>\xrefitem</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<H3><a name="Doxygen_python_further_details">17.4.4 Further details</a></H3>
|
||||
|
|
|
|||
|
|
@ -65,6 +65,10 @@ div.diagram {
|
|||
font-family: "Courier New", Courier, "Courier 10 Pitch", monospace;
|
||||
}
|
||||
|
||||
div.diagram li {
|
||||
margin-left: 0;
|
||||
}
|
||||
|
||||
ul li p {
|
||||
margin-left: 0;
|
||||
margin-right: 0;
|
||||
|
|
|
|||
Loading…
Reference in New Issue