Commit 0191e8e1 authored by Mike Kremer's avatar Mike Kremer

Added qmake function Doc() which adds build target doc to build doxygen...

Added qmake function Doc() which adds build target doc to build doxygen documentation of plugin. I also wrote a tutorial on
how to use this function and how to integrate the documentation package into OpenFlipper's help browser.

git-svn-id: http://www.openflipper.org/svnrepo/OpenFlipper/branches/Free@5676 383ad7c9-94d9-4d36-a494-682f7c89f535
parent 5e78d00d
# Doxyfile 1.5.6
#---------------------------------------------------------------------------
# Project related configuration options
......@@ -27,11 +27,6 @@ INLINE_INHERITED_MEMB = NO
FULL_PATH_NAMES = YES
STRIP_FROM_PATH =
STRIP_FROM_INC_PATH =
GENERATE_QHP = YES
QHP_NAMESPACE = "com.openflipper.dev"
QHP_VIRTUAL_FOLDER = "openflipper-1.0"
QCH_FILE = developer.qch
QHG_LOCATION = /usr/bin/qhelpgenerator
SHORT_NAMES = NO
JAVADOC_AUTOBRIEF = NO
QT_AUTOBRIEF = NO
......@@ -99,8 +94,7 @@ WARN_LOGFILE =
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = . \
../ObjectTypes #\
# ../ACG/Scenegraph
../ObjectTypes
INPUT_ENCODING = UTF-8
FILE_PATTERNS = *.c \
*.cc \
......@@ -148,7 +142,8 @@ FILE_PATTERNS = *.c \
*.moc \
*.xpm \
*.docu \
*.dox
*.dox \
*.qhcp
RECURSIVE = YES
EXCLUDE =
EXCLUDE_SYMLINKS = NO
......@@ -187,9 +182,9 @@ IGNORE_PREFIX =
GENERATE_HTML = YES
HTML_OUTPUT = html
HTML_FILE_EXTENSION = .html
HTML_HEADER = Doxygen/html/acg_header.html
HTML_HEADER = Doxygen/html/acg_header.html
HTML_FOOTER = Doxygen/html/acg_footer.html
HTML_STYLESHEET = Doxygen/html/acg_style.css
HTML_STYLESHEET = Doxygen/html/acg_style.css
HTML_ALIGN_MEMBERS = YES
GENERATE_HTMLHELP = YES
GENERATE_DOCSET = NO
......
......@@ -28,7 +28,7 @@ FULL_PATH_NAMES = YES
STRIP_FROM_PATH =
STRIP_FROM_INC_PATH =
GENERATE_QHP = YES
QHP_NAMESPACE = "org.openflipper.doc"
QHP_NAMESPACE = "doc.openflipper.dev"
QHP_VIRTUAL_FOLDER = "openflipper-1.0-dev"
QCH_FILE = developer.qch
QHG_LOCATION = /usr/bin/qhelpgenerator
......
This diff is collapsed.
<?xml version="1.0" encoding="utf-8" ?>
<QHelpCollectionProject version="1.0">
<docFiles>
<register>
<file>developer.qch</file>
<file>plugin-doctest.qch</file>
</register>
</docFiles>
</QHelpCollectionProject>
################################################################################
#
################################################################################
include( $$TOPDIR/qmake/all.include )
Plugin()
Doc()
DIRECTORIES = .
# Input
HEADERS += $$getFilesFromDir($$DIRECTORIES,*.hh)
SOURCES += $$getFilesFromDir($$DIRECTORIES,*.cc)
FORMS += $$getFilesFromDir($$DIRECTORIES,*.ui)
################################################################################
......@@ -9,6 +9,7 @@
* - \ref ex1b
* - \ref ex2
* - \ref ex3
* - \ref ex4
*
* \section plugin_sec Plugin Basics
*
......
/*! \page ex4 Create documentation for a plugin
*
* In this tutorial we will learn how to create automatically built
* documentation for a custom plugin. We use \c doxygen for this purpose and
* assume that you already made yourself familiar to it.
*
* \section ex4_openFlipperDoc The OpenFlipper documentation
*
* OpenFlipper provides its documentation and API references in two different
* forms:
*
* - As html files generated by doxygen (once generated by calling \c doxygen they
* can be found under the OpenFlipper/Docs directory in OpenFlipper's root folder).
* These are basically the same files as one can find on the website.
* - As compressed qt help file collection integrated into the application. They can be accessed
* by chosing \c Help in OpenFlipper's menu bar.
*
* Now developers have the possibility to deliver their own plugin specific documentation
* and integrate it into OpenFlipper's help system. Generating compressed qt help
* files is supported by doxygen since version 1.5.7, therefore we recommend to use
* the latest doxygen version in order to build compressed help files out of the documentation
* that can be integrated into the application's help browser.
*
* \section ex4_start So let's start...
*
* In this tutorial we want to create the documentation of our plugin that we have
* already created in \ref ex1. For this we go into our plugin's directory (here \c Plugin-SimplePlugin)
* and create a directory named \c Doxygen. This is the directory that will contain all
* the necessary docu-files. In this case we only create the file \c mainpage.docu.
*
* Now copy the file <code><b>Doxyfile.dox</b></code> (which can be found in <code><b>OpenFlipper/Doxygen/example</b></code>)
* into your plugin's directory and name it <code><b>Doxyfile</b></code>.
* Adapt the following project specific settings in the Doxyfile:
*
* \dontinclude Doxyfile.dox
* \skipline PROJECT_NAME
*
* \dontinclude Doxyfile.dox
* \skipline PROJECT_NUMBER
*
* \dontinclude Doxyfile.dox
* \skipline QHP_VIRTUAL_FOLDER
*
* \dontinclude Doxyfile.dox
* \skipline QCH_FILE
*
* \dontinclude Doxyfile.dox
* \skipline QHP_NAMESPACE
*
* The last thing to be done is adding <code><b>Doc()</b></code> to your qmake project file.
* This adds the target <code><b>doc</b></code> to the build system which builds the
* plugin's documentation.
*
* \dontinclude Plugin-DocTest.pro
* \skipline include
* \until DIRECTORIES
*
* After executing qmake (make sure to use qmake version >= 4, some linux distributions
* offer the symlink <code><b>qmake-qt4</b></code>) you just have to enter
*
* <br/><code><b>make doc</b></code><br/>
*
* to generate the documentation.
*
* All the files will be created in the folder Doc/html
* in your plugin's directory. You can now open the index.html to see it.
* When using doxygen >= 1.5.7 an additional .qch file (the filename can be specified
* in the <b>Doxyfile</b>) has been generated and copied to <b>OpenFlipper/Help/</b>
* in OpenFlipper's root directory. To integrate it into OpenFlipper's help browser
* go to <b>OpenFlipper/Help/</b> and open <b>Help.qhcp</b> in a text editor.
* Now add the line
*
* <br/><code><b>&lt;file&gt;plugin-doctest.qch&lt;/file&gt;</b></code><br/>
*
* under the <b>register</b> tag. The file now should look like this:
*
* \include Help.qhcp
*
* Now (still in <b>OpenFlipper/Help/</b>) execute
*
* <br/><code><b>qcollectiongenerator Help.qhcp -o Help.qhc</b></code><br/>
*
* Your documentation should now be available in OpenFlipper's help browser.
*/
No preview for this file type
No preview for this file type
......@@ -57,8 +57,8 @@ void CoreWidget::showHelpBrowser( ) {
return;
if(helpWidget_ == 0)
helpWidget_ = new HelpWidget(this, "qthelp://org.openflipper.doc/openflipper-1.0-dev/main.html",
"qthelp://org.openflipper.doc/openflipper-1.0-dev/");
helpWidget_ = new HelpWidget(this, "qthelp://doc.openflipper.dev/openflipper-1.0-dev/main.html",
"qthelp://doc.openflipper.dev/openflipper-1.0-dev/");
helpWidget_->show();
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment