Commit f14a8cf7 authored by Mike Kremer's avatar Mike Kremer

Added information on how to integrate plugin-doc into OpenFlipper's doc (WITH cross-references)

git-svn-id: http://www.openflipper.org/svnrepo/OpenFlipper/branches/Free@5868 383ad7c9-94d9-4d36-a494-682f7c89f535
parent e190848f
......@@ -191,7 +191,7 @@ HTML_ALIGN_MEMBERS = YES
GENERATE_HTMLHELP = YES
GENERATE_DOCSET = NO
DOCSET_FEEDNAME = "SimplePlugin 1.0 Help"
DOCSET_BUNDLE_ID = org.openflipper.simpleplugin
DOCSET_BUNDLE_ID = org.openflipper.plugin-simpleplugin
HTML_DYNAMIC_SECTIONS = NO
CHM_FILE =
HHC_LOCATION =
......
......@@ -3,7 +3,7 @@
<docFiles>
<register>
<file>developer.qch</file>
<file>plugin-doctest.qch</file>
<file>simpleplugin-doc.qch</file>
</register>
</docFiles>
</QHelpCollectionProject>
......@@ -6,7 +6,7 @@ include( $$TOPDIR/qmake/all.include )
Plugin()
Doc()
Doc(Plugin-SimplePlugin)
DIRECTORIES = .
......
......@@ -53,12 +53,19 @@
*
* <b>IMPORTANT:</b> 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.
* has to be unique, particularly the namespaces "org.openflipper.dev" and
* "org.openflipper.user" are reserved.
*
* The last thing to be done is adding <code><b>Doc()</b></code> to your qmake project file.
* The last thing to be done is adding <code><b>Doc(Plugin-SimplPlugin)</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.
*
* <b>IMPORTANT:</b> The argument passed to the Doc() function indicates the
* name of the documentation's subfolder that will be created by the build system.
* The name passed here has to match the one specified at the end of the <b>QHP_NAMESPACE</b>
* (they are not considered case-sensitive).
* If both names are not equal, cross-referencing won't work in OpenFlipper's help browser.
*
* \dontinclude Plugin-DocTest.pro
* \skipline include
* \until DIRECTORIES
......
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