Table of Contents
First go to the
page to get the latest distribution, if you have not downloaded doxygen already.
Compiling from source on UNIX
If you downloaded the source distribution, you need at least the following to build the executable:
tools flex, bison, libiconv and GNU make, and strip
In order to generate a Makefile for your platform, you need
version 2.8.12 or later.
To take full advantage of doxygen's features the following additional tools should be installed.
Qt Software's GUI toolkit
version 4.3 or higher (but currently, Qt 5.x is not yet supported). This is needed to build the GUI front-end doxywizard.
distribution: for instance
This is needed for generating , Postscript, and PDF output.
Needed for the include dependency graphs, the graphical inheritance graphs, and the collaboration graphs. If you compile graphviz yourself, make sure you do include freetype support (which requires the freetype library and header files), otherwise the graphs will not render proper text labels.
For formulas in the HTML output (when MathJax is not used) or in case you do not wish to use `pdflatex, the ghostscript interpreter is needed. You can find it at .
Compilation is now done by performing the following steps:
Unpack the archive, unless you already have done that: gunzip doxygen-$VERSION.src.tar.gz
# uncompress the archive
tar xf doxygen-$VERSION.src.tar
# unpack it
Create a build directory (for instance inside the source tree) cd doxygen-$VERSION
mkdir build
Run cmake with the makefile generator cmake -G "Unix Makefiles" ..
cmake tries to determine the platform you use, and will look for the requires tools. It will report if something is missing.
If you have Qt-4.3 or higher installed and want to build the GUI front-end, you should enable it as follows: cmake -Dbuild_wizard=YES ..
For an overview of other configuration options use cmake -L ..
Compile the program by running make: make
The program should compile without problems and the binaries (doxygen and optionally doxywizard) should be available in the bin directory within the build directory.
Optional: Generate the user manual. cmake -Dbuild_doc=YES ..
To let doxygen generate the HTML and PDF documentation.
The HTML directory within the build directory will now contain the html documentation (just point a HTML browser to the file index.html in the html directory).
Installing the binaries on UNIX
After the compilation of the source code do a make install to install doxygen. If you downloaded the binary distribution for UNIX, type: ./configure
make install
Binaries are installed into the directory &prefix&/bin. Use make install_docs to install the documentation and examples into &docdir&/doxygen.
&prefix& defaults to /usr/local but can be changed with the --prefix option of the configure script. The default &docdir& directory is &prefix&/share/doc/packages and can be changed with the --docdir option of the configure script.
Alternatively, you can also copy the binaries from the bin directory manually to some bin directory in your search path. This is sufficient to use doxygen.
NoteYou need the GNU install tool for this to work (it is part of the coreutils package). Other install tools may put the binaries in the wrong directory!
If you have a RPM or DEP package, then please follow the standard installation procedure that is required for these packages.
Compiling from source on Windows
From version 1.8.10 onwards, build files need to be generated by cmake. cmake can be downloaded from
At the moment only the express version of Visual Studio 2013 is tested, but other version might also work.
Alternatively, you can compile doxygen
The next step is to install modern versions of bison and flex (see . After installation and adding them to your path rename win_flex.exe to flex.exe and win_bison.exe to bison.exe) Furthermore you have to install python (version 2.6 or higher, see ). These packages are needed during the compilation process.
Download doxygen's source tarball and put it somewhere (e.g. use c:\tools)
Now start a visual studio native command shell (for either x86 or x64) and type cd c:\tools
tar zxvf doxygen-x.y.z.src.tar.gz
to unpack the sources (you can obtain tar from e.g. ). Alternatively you can use an unpack program, like 7-Zip (see ) or use the build in unpack feature of modern Windows systems).
Now your environment is setup to generate the required project files for doxygen.
cd into the doxygen-x.y.z directory, create and cd to a build directory mkdir build
cmake -G "Visual Studio 12 2013" ..
Note that compiling Doxywizard currently requires Qt version 4 (see ).
Also read the next section for additional tools you may need to install to run doxygen with certain features enabled.
Installing the binaries on Windows
Doxygen comes as a self-installing archive, so installation is extremely simple. Just follow the dialogs.
After installation it is recommended to also download and install GraphViz (version 2.20 or better is highly recommended). Doxygen can use the dot tool of the GraphViz package to render nicer diagrams, see the
option in the configuration file.
If you want to produce compressed HTML files (see ) in the config file, then you need the Microsoft HTML help workshop. You can download it from .
If you want to produce Qt Compressed Help files (see ) in the config file, then you need qhelpgenerator which is part of Qt. You can download Qt from .
In order to generate PDF output or use scientific formulas you will also need to install
a number of distributions exists. Popular ones that should work with doxygen are
Ghostscript can be
from Sourceforge.
After installing
and Ghostscript you'll need to make sure the tools latex.exe, pdflatex.exe, and gswin32c.exe are present in the search path of a command box. Follow
instructions if you are unsure and run the commands from a command box to verify it works.
section or return to theSupport and community documentation for Ogre3D
Welcome to the new Ogre Wiki!If you haven't done so already, be sure to visit the
to read about how the wiki works. Especially the
Backlinks...
Development Procedures
If you choose to use
as your , in combination with Ogre, you can import the API documentation into it. This way, you will be able to get context-sensitive help for all Ogre library functions by pressing F1. Just like with Qt library classes, a help tab will open with the relevant documentation.
This guide will guide you through the process of exporting the existing ogre documentation into a Qt help file.
Table of contents
New versions of
come with the ability to export to QT help format. However, there was a bug in doxygen versions 1.7.1 and below that cripples this feature (when pressing F1 on a function the help tab will show the top of the page, instead of scrolling down to the correct funtion). So make sure to install at least doxygen version 1.7.2.
Now that we have a good doxygen version, we have to recompile the Ogre documentation, but before we do that, we have to change the build config.
In a folder where you have the ogre source, say in ogre_src_v1-7-1/, modify the doxygen config file:
ogre_src_v1-7-1/Docs/src/html.cfg
At the bottom of the file, we will add some extra options:
Lines to add to html.cfg in linux#---------------------------------------------------------------------------
# Generate help files for Qt Creator
#---------------------------------------------------------------------------
GENERATE_QHP
= &../qthelp/ogre3d.qch&
QHP_NAMESPACE
QHP_VIRTUAL_FOLDER
= &ogre3d-1.7.1&
QHG_LOCATION
&/usr/bin/qhelpgenerator&
To be able to use qhelpgenerator, you need to have Qt installed. You also might need to change the location of the qhelpgenerator executable, depending on your configuration. Windows users would probably have to enter something like
html.cfg adaption for windows#---------------------------------------------------------------------------
# Generate help files for Qt Creator
#---------------------------------------------------------------------------
GENERATE_QHP
= &../qthelp/ogre3d.qch&
QHP_NAMESPACE
QHP_VIRTUAL_FOLDER
= &ogre3d-1.7.1&
QHG_LOCATION
&C:/Qt/bin/qhelpgenerator.exe&
At this point, doxygen should be properly configured for generating our Qt help file from the HTML that doxygen creates.
Now, for recompiling the docs, go to the folder Docs/ and issue the command
command for starting doxygendoxygen src/html.cfg
After the compiling is done, the generated Qt help file will be in
ogre_src_v1-7-1/Docs/api/qthelp/ogre3d.qch
We're almost there! The only thing we have to do now is load the ogre3d.qch file into Qt Creator. Start Qt creator and go to Tools & Options, open up Help and Documentation. Click Add and browse for the qch file that was just created, then Apply. I usually need to have some patience before the documentation starts working. It's best to close Qt creator at this point, and restart it.
Try it, open up some code that uses Ogre3D classes in the editor, move your mouse over one of their methods and press F1.
Advanced Search or Boolean SearchDefault search behaviorBy default, all search terms are optional.&It behaves like an OR logic.&Objects that contain the more terms are rated higher in the results and will appear first in their type. For example, wiki forum will find:objects that include both termsobjects that include the term wikiobjects that include the term forumRequiring termsAdd a plus sign ( + ) before a term to indicate that the term must appear in results.&Example: +wiki forum will find objects containing at least wiki. Objects with both terms and many occurences of the terms will appear first.Excluding termsAdd a minus sign ( - ) before a term to indicate that the term must not appear in the results.&To reduce a term's value without completely excluding it, .&Example: -wiki forum will find objects that do not contain wiki but contain forumGrouping termsUse parenthesis ( ) to group terms into subexpressions.&Example: +wiki +(forum blog) will find objects that contain wiki and forum or that contain wiki and blog in any order.Finding phrasesUse double quotes ( " " ) around a phrase to find terms in the exact order, exactly as typed.&Example: "Alex Bell" will not find Bell Alex or Alex G. Bell. Using wildcardsAdd an asterisk ( * ) after a term to find objects that include the root word. For example, run* will find:objects that include the term runobjects that include the term runnerobjects that include the term runningReducing a term's valueAdd a tilde ( ~ ) before a term to reduce its value indicate to the ranking of the results.&Objects that contain the term will appear lower than other objects (unlike the
which will completely exclude a term).&Example: +wiki ~forum will rate an object with only wiki higher that an object with wiki and
forum.Changing relevance valueAdd a less than ( & ) or greater than ( & ) sign before a term to change the term's contribution to the overall relevance value assigned to a object.&Example: +wiki +(&forum & blog) will find objects that contain wiki and forum or wiki and blog in any order. wiki forum will be rated higher.
Last changes
Online users
online usersasp.net - What is DefaultWsdlHelpGenerator.aspx? - Stack Overflow
Join the Stack Overflow Community
Stack Overflow is a community of 7.1 million programmers, just like you, helping each other.
J it only takes a minute:
Does anybody know what is DefaultWsdlHelpGenerator.aspx?
What its use? and the most important, when it is in use?
141k22188334
8,9691553117
A test page is auto-generated for web-services in ASP.NET.
DefaultWsdlHelpGenerator.aspx is used to generate that test page.
You can modify this generator to change how the test page is generated.
18.3k39120202
Your Answer
Sign up or
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Post as a guest
By posting your answer, you agree to the
Not the answer you're looking for?
Browse other questions tagged
rev .25948
Stack Overflow works best with JavaScript enabled}