feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: add doc project for the Extending Qt Creator Manual

Browse Source
This commit is contained in:
Leena Miettinen
2011-04-27 17:35:17 +02:00
parent 8a28be85c6
commit 1998afc41f
6 changed files with 84 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/api/coding-style.qdoc
+2
View File
@@ -22,7 +22,9 @@
/*!
\contentspage{index.html}{Qt Creator}
\previouspage
\page coding-style.html
\nextpage qtcreator-api.html
\title Qt Creator Coding Rules
doc/api/qtcreator-api.qdoc
+6 -7
View File
@@ -20,19 +20,18 @@
****************************************************************************/
/*!
\page index.html
\title Qt Creator
\contentspage{index.html}{Extending Qt Creator Manual}
\page qtcreator-api.html
Qt Creator is Nokia's crossplatform IDE. The core of Qt Creator is
\title Qt Creator API Reference
The core of Qt Creator is
basically only a \l{ExtensionSystem}{plugin loader}.
All functionality is implemented in plugins, the basis of Qt Creator is
All functionality is implemented in plugins. The basis of Qt Creator is
implemented in the \l{Core} {Core} Plugin. The plugin manager provides
simple means for plugin cooperation that allow plugins to provide
hooks for other plugin's extensions.
To get an overview of what parts of Qt Creator are extensible, have a look at the \l{Common Extension Tasks} page.
Also read and follow the Qt Creator \l{Qt Creator Coding Rules}{coding style and best practice patterns}.
\section1 Libraries
\section2 Core Libraries
doc/api/qtcreator-dev-online.qdocconf
+4
View File
@@ -0,0 +1,4 @@
# Run qdoc from the directory that contains this file.
include(../config/qtcreator-developer.qdocconf)
include(../config/qt-html-templates-online.qdocconf)
doc/api/qtcreator-dev.qdoc
+1 -1
View File
@@ -40,7 +40,7 @@
\o MIME Type Specification Files
\o External Tool Specification Files
\o Custom Wizard Specification Files
\o Highlight Definition Files (KATE)
\o \l{http://kate-editor.org/2005/03/24/writing-a-syntax-highlighting-file/}{Highlight Definition Files}
\o User Interface Text Guidelines
\o \l{Qt Creator Coding Rules}
\o \l{Qt Creator API Reference}
doc/api/qtcreator-dev.qdocconf
+3
View File
@@ -0,0 +1,3 @@
# Run qdoc from the directory that contains this file.
include(../config/qtcreator-developer.qdocconf)
include(../config/qt-html-templates.qdocconf)
doc/config/qtcreator-developer.qdocconf
+68
View File
@@ -0,0 +1,68 @@
project = "Qt Creator"
description = "Extending Qt Creator Manual"
language = Cpp
headerdirs = . \
../../src/libs/aggregation \
../../src/libs/cplusplus \
../../src/libs/extensionsystem \
../../src/libs/utils \
../../src/libs/qtcreatorcdbext \
../../src/plugins/coreplugin \
../../src/plugins/find \
../../src/plugins/locator \
../../src/plugins/debugger \
../../src/plugins/vcsbase \
../../src/plugins/projectexplorer
sourcedirs = . \
../../src/libs/aggregation \
../../src/libs/cplusplus \
../../src/libs/extensionsystem \
../../src/libs/utils \
../../src/libs/qtcreatorcdbext \
../../src/plugins/coreplugin \
../../src/plugins/find \
../../src/plugins/locator \
../../src/plugins/debugger \
../../src/plugins/vcsbase \
../../src/plugins/projectexplorer
# -- Generate complete documentation. Set this to 'false'
# to generate public API documentation only.
showinternal = true
headers.fileextensions = "*.h"
sources.fileextensions = "*.cpp *.qdoc"
imagedirs = $SRCDIR/images $SRCDIR/templates/images
outputdir = ../api/html
exampledirs =
indexes = qt.index
include(compat.qdocconf)
include(macros.qdocconf)
include(qt-cpp-ignore.qdocconf)
include(qt-defines.qdocconf)
qhp.projects = QtCreatorDev
qhp.QtCreatorDev.file = qtcreator-dev.qhp
qhp.QtCreatorDev.namespace = com.nokia.qtcreator.developer.$QTC_VERSION_TAG
qhp.QtCreatorDev.virtualFolder = doc
qhp.QtCreatorDev.indexTitle = Extending Qt Creator Manual
qhp.QtCreatorDev.filterAttributes = qtcreator $QTC_VERSION
qhp.QtCreatorDev.customFilters.QtCreator.name = Qt Creator $QTC_VERSION
qhp.QtCreatorDev.customFilters.QtCreator.filterAttributes = qtcreator $QTC_VERSION
qhp.QtCreatorDev.indexRoot =
qhp.QtCreator.subprojects = manual
qhp.QtCreator.subprojects.manual.title = Creating Qt Creator Plugins
qhp.QtCreator.subprojects.manual.indexTitle = Creating Qt Creator Plugins
qhp.QtCreator.subprojects.manual.type = manual
# Doxygen compatibility commands
macro.see = "\\sa"
macro.function = "\\fn"