History: Mogre XML commentation tool

• «
• »

            {img src="img/wiki_up/Mogre-XML-commentation-tool2.png" alt="" align="right"}
User ((User:smiley80|smiley80)) wrote a __tool which creates__ the XML comments file (''Mogre.xml'') from ''Mogre.dll'' and the Doxygen XML output of Ogre. Including this file in a ((MOGRE|Mogre)) project shows __comments for Mogre members__ in Visual Studio.

Also this tool can create comments for ((MogreNewt)). The created file ''MogreNewt.xml'' is still in the download package.

__Source__: 
http://mogresdk.googlecode.com/svn/trunk/smiley80/mogre_xml/

For questions and suggestions use this [http://www.ogre3d.org/addonforums/viewtopic.php?f=8&t=11646|forum thread].

!!Integration into Visual Studio
You don't need to run the tool with VisualStudio. The needed file is included in the download. 

Just copy ''MogreXml\bin\Debug\Mogre.xml'' to the location of the referenced ''Mogre.dll'' file of your project.

!!Tool usage
How to use the tool to create a ''Mogre.xml'' file from a new ''Mogre.dll'':

* Download and compile the source code
* Download Ogre's header files (e.g. from the current Ogre SDK)
* Download and install [http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc|Doxygen]
* Run doxywizard.exe
** Set the working and the destination directory to some temp folder
** Set the source code directory to the folder with Ogre's header files
** Enter 'ogre' as the project name and '1' as the project ID
** Uncheck 'html' and 'latex' output and check 'xml'
** Run Doxygen
* Create a new folder in the output folder of MogreXml (i.e. Debug) and name it 'xml'
* Copy 'namespace_ogre.xml' and all files that start with 'class_ogre' or 'struct_ogre' from the Doxygen's destination folder to the newly created folder
* Copy ''Mogre.dll'' and ''OgreMain.dll'' to the output folder of ''MogreXml''
* Open the command prompt and navigate to the output folder of ''MogreXml''

__Command line usage__:
{CODE(wrap="1", colors="dos")} MogreXml.exe <AssemblyPath> <NativeNamespace> <ManagedNamespace>{CODE}

Create Mogre comments:
{CODE(wrap="1", colors="dos")} MogreXml.exe .\Mogre.dll Ogre Mogre{CODE}

Create ((MogreNewt)) comments:
{CODE(wrap="1", colors="dos")} MogreXml.exe .\MogreNewt.dll OgreNewt MogreNewt{CODE}

__Note:__ You'll probably get warnings, that the encoding in some files is wrong. Open those files in a text editor, in the header change ''utf-8'' to ''utf-16'', save the file as ''utf-16'' (little endian) and run MogreXml again.