diff --git a/Doxyfile b/Doxyfile
index 240c9582aa5f79188f94fe1b38274b2c57d5ea49..cc58804b6d3e1b03a85064d209dab23bc76cdf38 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -1,4 +1,4 @@
-
+# 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
diff --git a/DoxyfileQtHelp b/DoxyfileQtHelp
index 095dcd84bcce7cd9ecd82216d56d220444f9f150..8bb54a61b1e362b6b7ee18c6c7afbbd024512757 100644
--- a/DoxyfileQtHelp
+++ b/DoxyfileQtHelp
@@ -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
diff --git a/Doxygen/example/Doxyfile.dox b/Doxygen/example/Doxyfile.dox
new file mode 100644
index 0000000000000000000000000000000000000000..0c1bae2b874816be57c3e59fa889aa70452e0299
--- /dev/null
+++ b/Doxygen/example/Doxyfile.dox
@@ -0,0 +1,309 @@
+
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+DOXYFILE_ENCODING = UTF-8
+PROJECT_NAME = DocTest-Plugin
+PROJECT_NUMBER = 1.0
+OUTPUT_DIRECTORY = ./Doc
+CREATE_SUBDIRS = NO
+OUTPUT_LANGUAGE = English
+BRIEF_MEMBER_DESC = YES
+REPEAT_BRIEF = YES
+ABBREVIATE_BRIEF = "The $name class " \
+ "The $name widget " \
+ "The $name file " \
+ is \
+ provides \
+ specifies \
+ contains \
+ represents \
+ a \
+ an \
+ the
+ALWAYS_DETAILED_SEC = NO
+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
+SHORT_NAMES = NO
+JAVADOC_AUTOBRIEF = NO
+QT_AUTOBRIEF = NO
+MULTILINE_CPP_IS_BRIEF = NO
+DETAILS_AT_TOP = NO
+INHERIT_DOCS = YES
+SEPARATE_MEMBER_PAGES = NO
+TAB_SIZE = 8
+ALIASES =
+OPTIMIZE_OUTPUT_FOR_C = NO
+OPTIMIZE_OUTPUT_JAVA = NO
+OPTIMIZE_FOR_FORTRAN = NO
+OPTIMIZE_OUTPUT_VHDL = NO
+BUILTIN_STL_SUPPORT = NO
+CPP_CLI_SUPPORT = NO
+SIP_SUPPORT = NO
+IDL_PROPERTY_SUPPORT = YES
+DISTRIBUTE_GROUP_DOC = NO
+SUBGROUPING = YES
+TYPEDEF_HIDES_STRUCT = NO
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+EXTRACT_ALL = NO
+EXTRACT_PRIVATE = YES
+EXTRACT_STATIC = YES
+EXTRACT_LOCAL_CLASSES = YES
+EXTRACT_LOCAL_METHODS = NO
+EXTRACT_ANON_NSPACES = NO
+HIDE_UNDOC_MEMBERS = NO
+HIDE_UNDOC_CLASSES = NO
+HIDE_FRIEND_COMPOUNDS = NO
+HIDE_IN_BODY_DOCS = NO
+INTERNAL_DOCS = NO
+CASE_SENSE_NAMES = YES
+HIDE_SCOPE_NAMES = NO
+SHOW_INCLUDE_FILES = YES
+INLINE_INFO = YES
+SORT_MEMBER_DOCS = YES
+SORT_BRIEF_DOCS = NO
+SORT_GROUP_NAMES = NO
+SORT_BY_SCOPE_NAME = NO
+GENERATE_TODOLIST = YES
+GENERATE_TESTLIST = YES
+GENERATE_BUGLIST = YES
+GENERATE_DEPRECATEDLIST= YES
+ENABLED_SECTIONS =
+MAX_INITIALIZER_LINES = 30
+SHOW_USED_FILES = YES
+SHOW_DIRECTORIES = YES
+SHOW_FILES = YES
+SHOW_NAMESPACES = YES
+FILE_VERSION_FILTER =
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+QUIET = NO
+WARNINGS = YES
+WARN_IF_UNDOCUMENTED = YES
+WARN_IF_DOC_ERROR = YES
+WARN_NO_PARAMDOC = NO
+WARN_FORMAT = "$file:$line: $text "
+WARN_LOGFILE =
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+INPUT = .
+INPUT_ENCODING = UTF-8
+FILE_PATTERNS = *.c \
+ *.cc \
+ *.cxx \
+ *.cpp \
+ *.c++ \
+ *.java \
+ *.ii \
+ *.ixx \
+ *.ipp \
+ *.i++ \
+ *.inl \
+ *.h \
+ *.hh \
+ *.hxx \
+ *.hpp \
+ *.h++ \
+ *.idl \
+ *.odl \
+ *.cs \
+ *.php \
+ *.php3 \
+ *.inc \
+ *.m \
+ *.mm \
+ *.dox \
+ *.C \
+ *.CC \
+ *.C++ \
+ *.II \
+ *.I++ \
+ *.H \
+ *.HH \
+ *.H++ \
+ *.CS \
+ *.PHP \
+ *.PHP3 \
+ *.M \
+ *.MM \
+ *.C \
+ *.H \
+ *.tlh \
+ *.diff \
+ *.patch \
+ *.moc \
+ *.xpm \
+ *.docu \
+ *.dox
+RECURSIVE = YES
+EXCLUDE =
+EXCLUDE_SYMLINKS = NO
+EXCLUDE_PATTERNS = */Debian*/* \
+ */.svn/* \
+ SimpleOpt*
+EXCLUDE_SYMBOLS =
+EXAMPLE_PATH = ./Doxygen/example/
+EXAMPLE_PATTERNS = *
+EXAMPLE_RECURSIVE = YES
+IMAGE_PATH = ./Doxygen/img/
+INPUT_FILTER =
+FILTER_PATTERNS =
+FILTER_SOURCE_FILES = NO
+#---------------------------------------------------------------------------
+# configuration options related to source browsing
+#---------------------------------------------------------------------------
+SOURCE_BROWSER = YES
+INLINE_SOURCES = NO
+STRIP_CODE_COMMENTS = YES
+REFERENCED_BY_RELATION = YES
+REFERENCES_RELATION = YES
+REFERENCES_LINK_SOURCE = YES
+USE_HTAGS = NO
+VERBATIM_HEADERS = YES
+#---------------------------------------------------------------------------
+# configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+ALPHABETICAL_INDEX = YES
+COLS_IN_ALPHA_INDEX = 5
+IGNORE_PREFIX =
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+GENERATE_HTML = YES
+HTML_OUTPUT = html
+HTML_FILE_EXTENSION = .html
+HTML_HEADER =
+HTML_FOOTER =
+HTML_STYLESHEET =
+HTML_ALIGN_MEMBERS = YES
+GENERATE_HTMLHELP = YES
+GENERATE_DOCSET = NO
+DOCSET_FEEDNAME = "Doxygen generated docs"
+DOCSET_BUNDLE_ID = org.openflipper.doc
+HTML_DYNAMIC_SECTIONS = NO
+CHM_FILE =
+HHC_LOCATION =
+GENERATE_CHI = NO
+CHM_INDEX_ENCODING =
+BINARY_TOC = NO
+TOC_EXPAND = NO
+DISABLE_INDEX = NO
+ENUM_VALUES_PER_LINE = 4
+GENERATE_TREEVIEW = YES
+TREEVIEW_WIDTH = 250
+FORMULA_FONTSIZE = 10
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+GENERATE_LATEX = NO
+LATEX_OUTPUT = latex
+LATEX_CMD_NAME = latex
+MAKEINDEX_CMD_NAME = makeindex
+COMPACT_LATEX = NO
+PAPER_TYPE = a4wide
+EXTRA_PACKAGES =
+LATEX_HEADER =
+PDF_HYPERLINKS = NO
+USE_PDFLATEX = NO
+LATEX_BATCHMODE = NO
+LATEX_HIDE_INDICES = NO
+#---------------------------------------------------------------------------
+# configuration options related to the RTF output
+#---------------------------------------------------------------------------
+GENERATE_RTF = NO
+RTF_OUTPUT = rtf
+COMPACT_RTF = NO
+RTF_HYPERLINKS = NO
+RTF_STYLESHEET_FILE =
+RTF_EXTENSIONS_FILE =
+#---------------------------------------------------------------------------
+# configuration options related to the man page output
+#---------------------------------------------------------------------------
+GENERATE_MAN = NO
+MAN_OUTPUT = man
+MAN_EXTENSION = .3
+MAN_LINKS = NO
+#---------------------------------------------------------------------------
+# configuration options related to the XML output
+#---------------------------------------------------------------------------
+GENERATE_XML = NO
+XML_OUTPUT = xml
+XML_SCHEMA =
+XML_DTD =
+XML_PROGRAMLISTING = YES
+#---------------------------------------------------------------------------
+# configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+GENERATE_AUTOGEN_DEF = NO
+#---------------------------------------------------------------------------
+# configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+GENERATE_PERLMOD = NO
+PERLMOD_LATEX = NO
+PERLMOD_PRETTY = YES
+PERLMOD_MAKEVAR_PREFIX =
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+ENABLE_PREPROCESSING = YES
+MACRO_EXPANSION = NO
+EXPAND_ONLY_PREDEF = NO
+SEARCH_INCLUDES = YES
+INCLUDE_PATH =
+INCLUDE_FILE_PATTERNS =
+PREDEFINED =
+EXPAND_AS_DEFINED =
+SKIP_FUNCTION_MACROS = YES
+#---------------------------------------------------------------------------
+# Configuration::additions related to external references
+#---------------------------------------------------------------------------
+TAGFILES =
+GENERATE_TAGFILE = Subdivision.tag
+ALLEXTERNALS = NO
+EXTERNAL_GROUPS = YES
+PERL_PATH = /usr/bin/perl
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+CLASS_DIAGRAMS = YES
+MSCGEN_PATH =
+HIDE_UNDOC_RELATIONS = YES
+HAVE_DOT = YES
+DOT_FONTNAME = FreeSans
+DOT_FONTPATH =
+CLASS_GRAPH = YES
+COLLABORATION_GRAPH = YES
+GROUP_GRAPHS = YES
+UML_LOOK = NO
+TEMPLATE_RELATIONS = YES
+INCLUDE_GRAPH = YES
+INCLUDED_BY_GRAPH = YES
+CALL_GRAPH = NO
+CALLER_GRAPH = NO
+GRAPHICAL_HIERARCHY = YES
+DIRECTORY_GRAPH = YES
+DOT_IMAGE_FORMAT = png
+DOT_PATH =
+DOTFILE_DIRS =
+DOT_GRAPH_MAX_NODES = 50
+MAX_DOT_GRAPH_DEPTH = 0
+DOT_TRANSPARENT = NO
+DOT_MULTI_TARGETS = YES
+GENERATE_LEGEND = YES
+DOT_CLEANUP = YES
+#---------------------------------------------------------------------------
+# Configuration::additions related to the search engine
+#---------------------------------------------------------------------------
+SEARCHENGINE = NO
diff --git a/Doxygen/example/Help.qhcp b/Doxygen/example/Help.qhcp
new file mode 100644
index 0000000000000000000000000000000000000000..53423bb880b7fdd8e0e33538a14f52c4920dc05f
--- /dev/null
+++ b/Doxygen/example/Help.qhcp
@@ -0,0 +1,9 @@
+
+
+
+
+ developer.qch
+ plugin-doctest.qch
+
+
+
diff --git a/Doxygen/example/Plugin-DocTest.pro b/Doxygen/example/Plugin-DocTest.pro
new file mode 100644
index 0000000000000000000000000000000000000000..13562fe511e295fcad2bc9175ff0ae3f3fd6d6cb
--- /dev/null
+++ b/Doxygen/example/Plugin-DocTest.pro
@@ -0,0 +1,18 @@
+################################################################################
+#
+################################################################################
+
+include( $$TOPDIR/qmake/all.include )
+
+Plugin()
+
+Doc()
+
+DIRECTORIES = .
+
+# Input
+HEADERS += $$getFilesFromDir($$DIRECTORIES,*.hh)
+SOURCES += $$getFilesFromDir($$DIRECTORIES,*.cc)
+FORMS += $$getFilesFromDir($$DIRECTORIES,*.ui)
+
+################################################################################
diff --git a/Doxygen/PluginProgramming.docu b/Doxygen/pluginProgramming.docu
similarity index 99%
rename from Doxygen/PluginProgramming.docu
rename to Doxygen/pluginProgramming.docu
index c5bbfce855bdc7442aff63767166941d7e33124e..adf8d046d9dcff3262ab9267f93b3a0f12478aef 100644
--- a/Doxygen/PluginProgramming.docu
+++ b/Doxygen/pluginProgramming.docu
@@ -9,6 +9,7 @@
* - \ref ex1b
* - \ref ex2
* - \ref ex3
+ * - \ref ex4
*
* \section plugin_sec Plugin Basics
*
diff --git a/Doxygen/tutorial4.docu b/Doxygen/tutorial4.docu
new file mode 100644
index 0000000000000000000000000000000000000000..20698feb2b729c8d46f228bf43d65c522ae15fd6
--- /dev/null
+++ b/Doxygen/tutorial4.docu
@@ -0,0 +1,84 @@
+/*! \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 Doxyfile.dox (which can be found in OpenFlipper/Doxygen/example)
+ * into your plugin's directory and name it Doxyfile.
+ * 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 Doc() to your qmake project file.
+ * This adds the target doc 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 qmake-qt4) you just have to enter
+ *
+ *
make doc
+ *
+ * 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 Doxyfile) has been generated and copied to OpenFlipper/Help/
+ * in OpenFlipper's root directory. To integrate it into OpenFlipper's help browser
+ * go to OpenFlipper/Help/ and open Help.qhcp in a text editor.
+ * Now add the line
+ *
+ *
<file>plugin-doctest.qch</file>
+ *
+ * under the register tag. The file now should look like this:
+ *
+ * \include Help.qhcp
+ *
+ * Now (still in OpenFlipper/Help/) execute
+ *
+ *
qcollectiongenerator Help.qhcp -o Help.qhc
+ *
+ * Your documentation should now be available in OpenFlipper's help browser.
+ */
diff --git a/Help/Help.qhc b/Help/Help.qhc
index 35b57aa64127b16abbfe9ef907ec4a7cb8232569..76720434fec8d66567902d6db5a6b49e3d50b0c7 100644
Binary files a/Help/Help.qhc and b/Help/Help.qhc differ
diff --git a/Help/developer.qch b/Help/developer.qch
index 3772bce5839f028eaaefef008dc70e0c05768f95..cc3c66b4f99190c25d81dba8a8311e44c8d7a0b2 100644
Binary files a/Help/developer.qch and b/Help/developer.qch differ
diff --git a/widgets/coreWidget/Help.cc b/widgets/coreWidget/Help.cc
index 393a0e46fc7f6611462c76f1f47409fb3a1cfd16..d34a21cb7992cc41d7e2067733df278499ec4ad1 100644
--- a/widgets/coreWidget/Help.cc
+++ b/widgets/coreWidget/Help.cc
@@ -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();