Commit 1998afc4 authored by Leena Miettinen's avatar Leena Miettinen

Doc: add doc project for the Extending Qt Creator Manual

parent 8a28be85
......@@ -22,7 +22,9 @@
/*!
\contentspage{index.html}{Qt Creator}
\previouspage
\page coding-style.html
\nextpage qtcreator-api.html
\title Qt Creator Coding Rules
......
......@@ -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
......
# Run qdoc from the directory that contains this file.
include(../config/qtcreator-developer.qdocconf)
include(../config/qt-html-templates-online.qdocconf)
......@@ -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}
......
# Run qdoc from the directory that contains this file.
include(../config/qtcreator-developer.qdocconf)
include(../config/qt-html-templates.qdocconf)
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"
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