Commit 5d9d8a0c authored by Mike Kremer's avatar Mike Kremer

Updated tutorial on documentation building

git-svn-id: http://www.openflipper.org/svnrepo/OpenFlipper/branches/Free@5738 383ad7c9-94d9-4d36-a494-682f7c89f535
parent 4e49d99d
# Doxyfile 1.5.6
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = DocTest-Plugin
PROJECT_NAME = SimplePlugin
PROJECT_NUMBER = 1.0
OUTPUT_DIRECTORY = ./Doc
OUTPUT_DIRECTORY = ./Docs
CREATE_SUBDIRS = NO
OUTPUT_LANGUAGE = English
BRIEF_MEMBER_DESC = YES
......@@ -27,11 +27,11 @@ INLINE_INHERITED_MEMB = NO
FULL_PATH_NAMES = YES
STRIP_FROM_PATH =
STRIP_FROM_INC_PATH =
GENERATE_QHP = YES
QHP_NAMESPACE = "doc.openflipper.testplugin"
QHP_VIRTUAL_FOLDER = "doctest-plugin-1.0"
QCH_FILE = plugin-doctest.qch
QHG_LOCATION = /usr/bin/qhelpgenerator
GENERATE_QHP = YES
QHP_NAMESPACE = "org.openflipper.simpleplugin"
QHP_VIRTUAL_FOLDER = "doc"
QCH_FILE = simpleplugin-doc.qch
QHG_LOCATION = /usr/bin/qhelpgenerator
SHORT_NAMES = NO
JAVADOC_AUTOBRIEF = NO
QT_AUTOBRIEF = NO
......@@ -98,7 +98,8 @@ WARN_LOGFILE =
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = .
INPUT = . \
../ObjectTypes
INPUT_ENCODING = UTF-8
FILE_PATTERNS = *.c \
*.cc \
......@@ -145,8 +146,7 @@ FILE_PATTERNS = *.c \
*.patch \
*.moc \
*.xpm \
*.docu \
*.dox
*.docu
RECURSIVE = YES
EXCLUDE =
EXCLUDE_SYMLINKS = NO
......@@ -156,8 +156,9 @@ EXCLUDE_PATTERNS = */Debian*/* \
EXCLUDE_SYMBOLS =
EXAMPLE_PATH = ./Doxygen/example/
EXAMPLE_PATTERNS = *
EXAMPLE_RECURSIVE = YES
IMAGE_PATH = ./Doxygen/img/
EXAMPLE_RECURSIVE = NO
IMAGE_PATH = ./Doxygen/pics/ \
./Doxygen/screenshots/
INPUT_FILTER =
FILTER_PATTERNS =
FILTER_SOURCE_FILES = NO
......@@ -184,14 +185,14 @@ IGNORE_PREFIX =
GENERATE_HTML = YES
HTML_OUTPUT = html
HTML_FILE_EXTENSION = .html
HTML_HEADER =
HTML_HEADER =
HTML_FOOTER =
HTML_STYLESHEET =
HTML_STYLESHEET =
HTML_ALIGN_MEMBERS = YES
GENERATE_HTMLHELP = YES
GENERATE_DOCSET = NO
DOCSET_FEEDNAME = "Doxygen generated docs"
DOCSET_BUNDLE_ID = org.openflipper.doc
DOCSET_FEEDNAME = "SimplePLugin 1.0 Help"
DOCSET_BUNDLE_ID = org.openflipper.simpleplugin
HTML_DYNAMIC_SECTIONS = NO
CHM_FILE =
HHC_LOCATION =
......@@ -199,7 +200,7 @@ GENERATE_CHI = NO
CHM_INDEX_ENCODING =
BINARY_TOC = NO
TOC_EXPAND = NO
DISABLE_INDEX = NO
DISABLE_INDEX = YES
ENUM_VALUES_PER_LINE = 4
GENERATE_TREEVIEW = YES
TREEVIEW_WIDTH = 250
......
......@@ -39,13 +39,20 @@
* \skipline PROJECT_NUMBER
*
* \dontinclude Doxyfile.dox
* \skipline QHP_VIRTUAL_FOLDER
* \skipline QCH_NAMESPACE
*
* \dontinclude Doxyfile.dox
* \skipline QCH_FILE
* \skipline QHP_FILE
*
* \dontinclude Doxyfile.dox
* \skipline QHP_NAMESPACE
* \skipline DOCSET_FEEDNAME
*
* \dontinclude Doxyfile.dox
* \skipline DOCSET_BUNDLE_ID
*
* IMPORTANT: For your documentation to integrate seamlessly into OpenFlipper's help
* system you have to leave the <b>QHP_VIRTUAL_FOLDER</b> untouched! Further QCH_NAMESPACE
* has to be unique, particularly the namespace "org.openflipper.dev" is reserved.
*
* 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
......
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