Mogre XML commentation tool        
Print

Image

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 the MogreNewt physics library.

help For questions and suggestions use this forum thread(external link).

 

Integration into Visual Studio

 
Just download the file(s) and put them into your binary directories of your C# project (bin/Debug and bin/Release).

Direct download:

 

Tool usage

 
Note:
Running the tool is only necessary if you want to create the documentation of a newer Mogre or MogreNewt version.

Source:
http://mogresdk.googlecode.com/svn/trunk/smiley80/mogre_xml/(external link)

How to use the tool to create a new Mogre.xml file from a new Mogre.dll:

  1. Download and compile the MogreXml source code
  2. Download Ogre's header files (e.g. from the current Ogre SDK)
  3. Download and install Doxygen(external link)
  4. Run doxywizard.exe
    1. Set the working and the destination directory to some temp folder
    2. Set the source code directory to the folder with Ogre's header files
    3. Enter 'ogre' as the project name and '1' as the project ID
    4. Uncheck 'html' and 'latex' output and check 'xml'
    5. Run Doxygen
  5. Create a new folder in the output folder of MogreXml (i.e. Debug) and name it 'xml'
  6. 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
  7. Copy Mogre.dll and OgreMain.dll to the output folder of MogreXml
  8. Open the command prompt and navigate to the output folder of ''MogreXml'

 
Command line usage:

MogreXml.exe <AssemblyPath> <NativeNamespace> <ManagedNamespace> [options]

Options:

-d:Directory Directory that contains the doxygen XML files (default is ".\xml\")

 
Create Mogre comments:

MogreXml.exe .\Mogre.dll Ogre Mogre

 
Create MogreNewt comments:

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.


Alias: Mogre_XML_commentation_tool


Contributors to this page: Beauty10198 points  , smiley80215 points  and jacmoe133512 points  .
Page last modified on Sunday 15 of April, 2012 20:39:30 UTC by Beauty10198 points .


The content on this page is licensed under the terms of the Creative Commons Attribution-ShareAlike License.
As an exception, any source code contributed within the content is released into the Public Domain.