OGRE Wiki
Support and community documentation for Ogre3D
Ogre Forums
ogre3d.org
Log in
Username:
Password:
CapsLock is on.
Remember me (for 1 year)
Log in
Home
Tutorials
Tutorials Home
Basic Tutorials
Intermediate Tutorials
Mad Marx Tutorials
In Depth Tutorials
Older Tutorials
External Tutorials
Cookbook
Cookbook Home
CodeBank
Snippets
Experiences
Ogre Articles
Libraries
Libraries Home
Alternative Languages
Assembling A Toolset
Development Tools
OGRE Libraries
List of Libraries
Tools
Tools Home
DCC Tools
DCC Tutorials
DCC Articles
DCC Resources
Assembling a production pipeline
Development
Development Home
Roadmap
Building Ogre
Installing the Ogre SDK
Setting Up An Application
Ogre Wiki Tutorial Framework
Frequently Asked Questions
Google Summer Of Code
Help Requested
Ogre Core Articles
Community
Community Home
Projects Using Ogre
Recommended Reading
Contractors
Wiki
Immediate Wiki Tasklist
Wiki Ideas
Wiki Guidelines
Article Writing Guidelines
Wiki Styles
Wiki Page Tracker
Ogre Wiki Help
Ogre Wiki Help Overview
Help - Basic Syntax
Help - Images
Help - Pages and Structures
Help - Wiki Plugins
Toolbox
Freetags
Categories
List Pages
Structures
Trackers
Statistics
Rankings
List Galleries
Ogre Lexicon
Comments
History: Mogre XML commentation tool
View page
Source of version: 7
(current)
{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 the ((MogreNewt)) physics library. %help% For questions and suggestions use this [http://www.ogre3d.org/addonforums/viewtopic.php?f=8&t=11646|forum thread]. !!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: * [http://mogresdk.googlecode.com/svn/trunk/smiley80/mogre_xml/bin/Debug/Mogre.xml|Mogre.xml] * [http://mogresdk.googlecode.com/svn/trunk/smiley80/mogre_xml/bin/Debug/MogreNewt.xml|MogreNewt.xml] !!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/ How to use the tool to create a new ''Mogre.xml'' file from a new ''Mogre.dll'': # Download and compile the MogreXml 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> [options]{CODE} Options: || __-d:Directory__ | Directory that contains the doxygen XML files (default is ".\xml\") || 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. --- Alias: (alias(Mogre_XML_commentation_tool))
Search by Tags
Search Wiki by Freetags
Latest Changes
IDE Eclipse
FMOD SoundManager
HDRlib
Building Ogre V2 with CMake
Ogre 2.1 FAQ
Minimal Ogre Collision
Artifex Terra
OpenMB
Advanced Mogre Framework
MogreSocks
...more
Search
Find
Advanced
Search Help
Online Users
128 online users