Mogre XML commentation tool

From Ogre Wiki

User 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 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.

Download: Here (MogreXml.zip)

• file Mogre.xml (ready to use)
• file MogreNewt.xml (ready to use)
• MogreXML tool (for recreating xml files)

For questions and suggestions use this 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 unpack MogreXml.zip
• Download Ogre's header files (e.g. from the current Ogre SDK)
• Download and install 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:

MogreXml.exe <AssemblyPath> <NativeNamespace> <ManagedNamespace>

Create Mogre commentations:

MogreXml.exe Mogre.dll Ogre Mogre

Create MogreNewt commentations:

MogreXml.exe MogreNewt.dll OgreNewt MogreNewt

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.