mummy
1.0.3
|
mummy is a command line executable that generates C# wrappers from gccxml output. A C# class is generated to wrap the wrappable class named in the gccxml output. Settings to control the wrapping are given inline directly in the class header file or in the MummySettings.xml input file.
mummy transfers comment blocks in the source code as XML documentation comments. If they are already XML documentation comments, as indicated by the presence of <remarks> or <summary> in the comment block, then they are simply copied over as is. If not, they are surrounded by <remarks> and </remarks> tags to indicate to doxygen that the comment block is the detailed description block.
The following table shows XML documentation tags and their doxygen and JavaDoc equivalents:
/// XML documentation doxygen command equivalent Javadoc comment tag equivalent /// ================================================== ========================== =============================== /// <remarks> \detail None /// <summary> \brief None /// <author>name</author> \author name @author name /// <obsolete>description</obsolete> None @deprecated description /// <exception cref="exception-class">text</exception> None @exception exception-class text /// <param name="paramname">text</param> \param paramname text @param paramname text /// <returns>text</returns> \return text @return text /// <seealso cref="typename"/> \ref typename @see typename /// <seealso cref="typename.member"/> \sa typename::member @see typename#member /// <value>property-description</value> None @value property-description /// <version>text</version> None @version text ///
Sources: http://msdn2.microsoft.com/en-us/library/fzdc5d5k%28VS.80%29.aspx http://www.stack.nl/~dimitri/doxygen/xmlcmds.html Full doxygen manual: http://www.stack.nl/~dimitri/doxygen/manual.html \author David Cole