<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html;charset=ISO-8859-1" http-equiv="Content-Type">
</head>
<body bgcolor="#ffffff" text="#000000">
I actually don't care too much what format we use--using the wiki
markup language for documentation would be fine _if_ we could
automatically generate not just code docs, but user docs (i.e.
configuration etc.) from it. reStructuredText would be fine too. I just
want to be able to write, in code, docs that can be generated to tell
other people how to use various options _without_ them needing to go
into the code.<br>
<br>
FYI, here are the various commands Doxygen supports. Not all are
relevant to Python (many support C or Java constructs), but many
support general features, such as grouping of doc comments that are far
apart in the codebase, inclusion of documentation from other files, etc.<br>
<br>
But like I say, I'm pretty much agnostic on this. I'd just like to be
able to contribute to the dox in a way that makes it likely my
contributions will stay reasonably up to date with future versions.
Often, I find that incorrect documentation is worse than no
documentation at all :-(<br>
<br>
<font face="Verdana, Arial, Helvetica" size="-1"> </font>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tbody>
<tr>
<td valign="top" width="100%">
<multicol cols="3">
<ul>
<font face="Verdana, Arial, Helvetica" size="-1">
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmda">\a</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdaddindex">\addindex</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdaddtogroup">\addtogroup</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdanchor">\anchor</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdarg">\arg</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdattention">\attention</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdauthor">\author</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdb">\b</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdbrief">\brief</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdbug">\bug</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdc">\c</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdcallgraph">\callgraph</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdcategory">\category</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdclass">\class</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdcode">\code</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdcond">\cond</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdcopydoc">\copydoc</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmddate">\date</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmddef">\def</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmddefgroup">\defgroup</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmddeprecated">\deprecated</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmddir">\dir</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmddontinclude">\dontinclude</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmddot">\dot</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmddotfile">\dotfile</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmde">\e</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdelse">\else</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdelseif">\elseif</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdem">\em</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdendcode">\endcode</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdendcond">\endcond</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdenddot">\enddot</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdendhtmlonly">\endhtmlonly</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdendif">\endif</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdendlatexonly">\endlatexonly</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdendlink">\endlink</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdendmanonly">\endmanonly</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdendverbatim">\endverbatim</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdendxmlonly">\endxmlonly</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdenum">\enum</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdexample">\example</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdexception">\exception</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdfdollar">\f$</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdfbropen">\f[</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdfbrclose">\f]</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdfile">\file</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdfn">\fn</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdhideinitializer">\hideinitializer</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdhtmlinclude">\htmlinclude</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdhtmlonly">\htmlonly</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdif">\if</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdifnot">\ifnot</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdimage">\image</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdinclude">\include</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdincludelineno">\includelineno</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdingroup">\ingroup</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdinternal">\internal</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdinvariant">\invariant</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdinterface">\interface</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdlatexonly">\latexonly</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdli">\li</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdline">\line</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdlink">\link</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdmainpage">\mainpage</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdmanonly">\manonly</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdn">\n</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdname">\name</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdnamespace">\namespace</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdnosubgrouping">\nosubgrouping</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdnote">\note</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdoverload">\overload</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdp">\p</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdpackage">\package</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdpage">\page</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdpar">\par</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdparagraph">\paragraph</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdparam">\param</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdpost">\post</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdpre">\pre</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmd_php_only">\private
(PHP only)</a> </li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmd_php_only">\privatesection
(PHP only)</a> </li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdproperty">\property</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmd_php_only">\protected
(PHP only)</a> </li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmd_php_only">\protectedsection
(PHP only)</a> </li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdprotocol">\protocol</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmd_php_only">\public
(PHP only)</a> </li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmd_php_only">\publicsection
(PHP only)</a> </li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdref">\ref</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdrelates">\relates</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdrelatesalso">\relatesalso</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdremarks">\remarks</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdreturn">\return</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdretval">\retval</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdsa">\sa</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdsection">\section</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdsee">\see</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdshowinitializer">\showinitializer</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdsince">\since</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdskip">\skip</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdskipline">\skipline</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdstruct">\struct</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdsubpage">\subpage</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdsubsection">\subsection</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdsubsubsection">\subsubsection</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdtest">\test</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdthrow">\throw</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdtodo">\todo</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdtypedef">\typedef</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdunion">\union</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmduntil">\until</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdvar">\var</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdverbatim">\verbatim</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdverbinclude">\verbinclude</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdversion">\version</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdwarning">\warning</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdweakgroup">\weakgroup</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdxmlonly">\xmlonly</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdxrefitem">\xrefitem</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmddollar">\$</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdat">\@</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdbackslash">\\</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdamp">\&</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdtilde">\~</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdlt">\<</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdgt">\></a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdhash">\#</a>
</li>
<li><a
href="http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdperc">\%</a>
</li>
</font>
</ul>
</multicol>
<p>
</p>
</td>
</tr>
</tbody>
</table>
<br>
<br>
Fred Drake wrote:
<blockquote
cite="mid9cee7ab80604271039l6e5df86fp57d724350be809bd@mail.gmail.com"
type="cite">
<pre wrap="">On 4/27/06, Schwols, Keith C <a class="moz-txt-link-rfc2396E" href="mailto:keith.c.schwols@intel.com"><keith.c.schwols@intel.com></a> wrote:
</pre>
<blockquote type="cite">
<pre wrap="">Wouldn't it be good to support writing documentation in Wiki Markup Language in
the source python files? That should provide a simple mechanism to generate Wiki
pages of documentation for the MoinMaster wiki (one wiki page per Moin source
file.)
</pre>
</blockquote>
<pre wrap=""><!---->
Epydoc supports reStructuredText, and so does MoinMoin. That's good
enough for me. :-)
-Fred
--
Fred L. Drake, Jr. <fdrake at gmail.com>
"Don't let schooling interfere with your education." -- Mark Twain
-------------------------------------------------------
Using Tomcat but need to do more? Need to support web services, security?
Get stuff done quickly with pre-integrated technology to make your job easier
Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo
<a class="moz-txt-link-freetext" href="http://sel.as-us.falkag.net/sel?cmd=k&kid0709&bid&3057&dat1642">http://sel.as-us.falkag.net/sel?cmd=k&kid0709&bid&3057&dat1642</a>
_______________________________________________
Moin-user mailing list
<a class="moz-txt-link-abbreviated" href="mailto:Moin-user@lists.sourceforge.net">Moin-user@lists.sourceforge.net</a>
<a class="moz-txt-link-freetext" href="https://lists.sourceforge.net/lists/listinfo/moin-user">https://lists.sourceforge.net/lists/listinfo/moin-user</a>
</pre>
</blockquote>
<br>
</body>
</html>