[Moin-user] Any interest in making Doxygen the standard doctool for MoinMoin?

Kenneth McDonald kenneth.m.mcdonald at sbcglobal.net
Thu Apr 27 12:45:03 EDT 2006 

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.

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.

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 :-(

    * \a <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmda>
    * \addindex
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdaddindex>
    * \addtogroup
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdaddtogroup>
    * \anchor
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdanchor>
    * \arg <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdarg>
    * \attention
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdattention>
    * \author
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdauthor>
    * \b <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdb>
    * \brief
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdbrief>
    * \bug <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdbug>
    * \c <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdc>
    * \callgraph
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdcallgraph>
    * \category
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdcategory>
    * \class
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdclass>
    * \code <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdcode>
    * \cond <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdcond>
    * \copydoc
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdcopydoc>
    * \date <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmddate>
    * \def <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmddef>
    * \defgroup
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmddefgroup>
    * \deprecated
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmddeprecated>
    * \dir <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmddir>
    * \dontinclude
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmddontinclude>
    * \dot <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmddot>
    * \dotfile
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmddotfile>
    * \e <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmde>
    * \else <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdelse>
    * \elseif
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdelseif>
    * \em <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdem>
    * \endcode
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdendcode>
    * \endcond
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdendcond>
    * \enddot
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdenddot>
    * \endhtmlonly
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdendhtmlonly>
    * \endif
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdendif>
    * \endlatexonly
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdendlatexonly>

    * \endlink
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdendlink>
    * \endmanonly
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdendmanonly>
    * \endverbatim
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdendverbatim>
    * \endxmlonly
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdendxmlonly>
    * \enum <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdenum>
    * \example
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdexample>
    * \exception
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdexception>
    * \f$ <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdfdollar>
    * \f[ <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdfbropen>
    * \f]
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdfbrclose>
    * \file <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdfile>
    * \fn <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdfn>
    * \hideinitializer
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdhideinitializer>

    * \htmlinclude
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdhtmlinclude>
    * \htmlonly
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdhtmlonly>
    * \if <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdif>
    * \ifnot
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdifnot>
    * \image
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdimage>
    * \include
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdinclude>
    * \includelineno
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdincludelineno>

    * \ingroup
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdingroup>
    * \internal
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdinternal>
    * \invariant
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdinvariant>
    * \interface
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdinterface>
    * \latexonly
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdlatexonly>
    * \li <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdli>
    * \line <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdline>
    * \link <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdlink>
    * \mainpage
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdmainpage>
    * \manonly
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdmanonly>
    * \n <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdn>
    * \name <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdname>
    * \namespace
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdnamespace>
    * \nosubgrouping
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdnosubgrouping>

    * \note <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdnote>
    * \overload
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdoverload>
    * \p <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdp>
    * \package
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdpackage>
    * \page <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdpage>
    * \par <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdpar>
    * \paragraph
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdparagraph>
    * \param
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdparam>
    * \post <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdpost>
    * \pre <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdpre>
    * \private (PHP only)
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmd_php_only>
    * \privatesection (PHP only)
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmd_php_only>
    * \property
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdproperty>
    * \protected (PHP only)
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmd_php_only>
    * \protectedsection (PHP only)
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmd_php_only>
    * \protocol
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdprotocol>
    * \public (PHP only)
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmd_php_only>
    * \publicsection (PHP only)
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmd_php_only>
    * \ref <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdref>
    * \relates
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdrelates>
    * \relatesalso
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdrelatesalso>
    * \remarks
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdremarks>
    * \return
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdreturn>
    * \retval
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdretval>
    * \sa <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdsa>
    * \section
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdsection>
    * \see <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdsee>
    * \showinitializer
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdshowinitializer>

    * \since
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdsince>
    * \skip <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdskip>
    * \skipline
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdskipline>
    * \struct
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdstruct>
    * \subpage
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdsubpage>
    * \subsection
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdsubsection>
    * \subsubsection
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdsubsubsection>

    * \test <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdtest>
    * \throw
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdthrow>
    * \todo <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdtodo>
    * \typedef
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdtypedef>
    * \union
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdunion>
    * \until
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmduntil>
    * \var <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdvar>
    * \verbatim
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdverbatim>
    * \verbinclude
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdverbinclude>
    * \version
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdversion>
    * \warning
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdwarning>
    * \weakgroup
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdweakgroup>
    * \xmlonly
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdxmlonly>
    * \xrefitem
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdxrefitem>
    * \$ <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmddollar>
    * \@ <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdat>
    * \\
      <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdbackslash>
    * \& <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdamp>
    * \~ <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdtilde>
    * \< <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdlt>
    * \> <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdgt>
    * \# <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdhash>
    * \% <http://www.stack.nl/%7Edimitri/doxygen/commands.html#cmdperc>



Fred Drake wrote:
> On 4/27/06, Schwols, Keith C <keith.c.schwols at intel.com> wrote:
>   
>> 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.)
>>     
>
> 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
> http://sel.as-us.falkag.net/sel?cmd=k&kid0709&bid&3057&dat1642
> _______________________________________________
> Moin-user mailing list
> Moin-user at lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/moin-user
>
>   

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/moin-user/attachments/20060427/dbef5ea1/attachment.html>

More information about the Moin-user mailing list