Commit 2f2588be authored by con's avatar con

Fixes: - API doc main page

parent dce0855f
......@@ -3,7 +3,28 @@
\title Qt Creator
Qt Creator is Qt Software's crossplatform IDE. The core of Qt Creator is
basically only a \l{Plugin Loader Framework}{plugin loader}.
basically only a \l{ExtensionSystem}{plugin loader}.
\section1 Core Libraries
There are a few core libraries used by many parts of Qt Creator.
\table
\header
\o Library Name
\o Description
\row
\o \l{Aggregation}{Aggregation}
\o Adds functionality for "glueing" QObjects of different
types together, so you can "cast" between them.
\row
\o \l{ExtensionSystem}{ExtensionSystem}
\o Implements the plugin loader framework. Provides a base class for plugins and
basic mechanisms for plugin interaction like an object pool.
\endtable
\section1 Plugins
......@@ -18,44 +39,40 @@
\o Description
\row
\o \l{Core Plugin} {Core}
\o \l{Core} {Core}
\o The core plugin. Provides the main window and managers for editors,
actions, mode windows and files, just to mention the most important ones.
\endtable
*/
/*!
\page classes.html
\title Qt Creator Classes and Namespaces
\section1 Classes
\title Qt Creator Classes
\generatelist classes
*/
\section1 Namespaces
/*!
\page namespaces.html
\title Qt Creator Namespaces
\generatelist{namespaces}
\generatelist namespaces
*/
/*!
\page interfaces.html
\title Interfaces
\page mainclasses.html
\title Qt Creator Main Classes
\generatelist mainclasses
*/
/*!
\page functions.html
\title Member Function Index
\generatelist functionindex
*/
\title Qt Creator Functions
/*!
\group pluginloader
\title Plugin Loader Framework
\generatelist functionindex
*/
/*!
......
......@@ -4,11 +4,13 @@ description = Qt Creator API Documentation
language = Cpp
headerdirs = . \
../../src/libs/aggregation \
../../src/libs/extensionsystem \
../../src/plugins/core \
../../src/plugins/core/actionmanager
sourcedirs = . \
../../src/libs/aggregation \
../../src/libs/extensionsystem \
../../src/plugins/core \
../../src/plugins/core/actionmanager
......@@ -20,8 +22,8 @@ imagedirs = .
indexes = $QTDIR/doc/html/qt.index
outputdir = ./html-api
base = file:./html-api
outputdir = ./html
base = file:./html
versionsym = 0.9.2
codeindent = 1
......
......@@ -37,12 +37,12 @@
/*!
\namespace Aggregation
\brief Contains support for bundling related components, such that
each component exposes the properties and behavior of the
\brief The Aggregation namespace contains support for bundling related components,
such that each component exposes the properties and behavior of the
other components to the outside.
Components that are bundled to an Aggregate can be "cast" to each other
and have a coupled life cycle. See the documentation of Aggregate for
and have a coupled life cycle. See the documentation of Aggregation::Aggregate for
details and examples.
*/
......
......@@ -38,6 +38,7 @@
/*!
\class ExtensionSystem::IPlugin
\mainclass
\brief Base class for all plugins.
The IPlugin class is an abstract class that must be implemented
......
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