Commit 8e261e0b authored by con's avatar con

Fixes: - Start on API documentation generation

parent 7cf9888a
h3.fn,span.fn
{
margin-left: 1cm;
text-indent: -1cm;
}
a:link
{
color: #004faf;
text-decoration: none
}
a:visited
{
color: #672967;
text-decoration: none
}
td.postheader
{
font-family: sans-serif
}
tr.address
{
font-family: sans-serif
}
body
{
background: #ffffff;
color: black
}
table tr.odd {
background: #f0f0f0;
color: black;
}
table tr.even {
background: #e4e4e4;
color: black;
}
table.annotated th {
padding: 3px;
text-align: left
}
table.annotated td {
padding: 3px;
}
table tr pre
{
padding-top: none;
padding-bottom: none;
padding-left: none;
padding-right: none;
border: none;
background: none
}
tr.qt-style
{
background: #a2c511;
color: black
}
body pre
{
padding: 0.2em;
border: #e7e7e7 1px solid;
background: #f1f1f1;
color: black
}
span.preprocessor, span.preprocessor a
{
color: darkblue;
}
span.comment
{
color: darkred;
font-style: italic
}
span.string,span.char
{
color: darkgreen;
}
.subtitle
{
font-size: 0.8em
}
.small-subtitle
{
font-size: 0.65em
}
/*! /*!
\page index.html \page index.html
\title Workbench \title Qt Creator
Workbench is Trolltech's crossplatform IDE. The core of Workbench is Qt Creator is Qt Software's crossplatform IDE. The core of Qt Creator is
basically only a \l{Plugin Loader Framework}{plugin loader} comparable to basically only a \l{Plugin Loader Framework}{plugin loader}.
Eclipse. All major functionality is then added via plugins. The plugins
necessary for a full IDE will be provided by Trolltech, possible addons or
replacements of existing plugins can be provided by anyone. This means that
there will be a place where plugins can be shared.
The main features of Workbench are:
\list
\o Fast since it's written in C++
\o Easy and fast to use (the entire IDE can be controlled via short cuts)
\o Highly extensible
\o Integrated C++ language support, i.e. code completion, class browser, ...
\o Integrated debugger framework and outstanding support for gdb
\o Integrated Qt Designer
\o Qtopia Integration
\endlist
\section1 Plugins \section1 Plugins
As already mentioned, Workbench is basically only a plugin loader framework As already mentioned, Qt Creator is basically only a plugin loader framework
which gets its IDE functionality through plugins. The most important plugin which gets its IDE functionality through plugins. The most important plugin
is the QWorkbench plugin which provides all the basic functionality needed is the Core plugin which provides all the basic functionality needed
later to integrate e.g. editors or tool windows. later to integrate e.g. editors or mode windows.
\table \table
\header \header
...@@ -34,9 +18,9 @@ ...@@ -34,9 +18,9 @@
\o Description \o Description
\row \row
\o \l{QWorkbench Plugin} {QWorkbench} \o \l{Core Plugin} {Core}
\o The core plugin. Provides the main window and managers for editors, \o The core plugin. Provides the main window and managers for editors,
actions, tool windows and files, just to mention the most important ones. actions, mode windows and files, just to mention the most important ones.
\endtable \endtable
...@@ -44,7 +28,7 @@ ...@@ -44,7 +28,7 @@
/*! /*!
\page classes.html \page classes.html
\title Workbench Classes and Namespaces \title Qt Creator Classes and Namespaces
\section1 Classes \section1 Classes
...@@ -75,24 +59,7 @@ ...@@ -75,24 +59,7 @@
*/ */
/*! /*!
\group qwb \group qtc
\title QWorkbench Plugin
*/
/*! \title Core Plugin
\namespace Trolltech
*/
/*!
\namespace Trolltech::QWorkbench
*/
/*!
\namespace Trolltech::QWorkbench::Internal
\brief Classes that manage and control internal features of the workbench environment.
*/
/*!
\namespace ExtensionSystem
*/ */
...@@ -304,7 +304,7 @@ void IPlugin::addObject(QObject *obj) ...@@ -304,7 +304,7 @@ void IPlugin::addObject(QObject *obj)
plugin pool. Usually, registered objects must be removed from plugin pool. Usually, registered objects must be removed from
the object pool and deleted by hand. the object pool and deleted by hand.
Objects added to the pool via addAutoReleasedObject are automatically Objects added to the pool via addAutoReleasedObject are automatically
removed and deleted in \i reverse order of registration when removed and deleted in reverse order of registration when
the IPlugin instance is destroyed. the IPlugin instance is destroyed.
\sa PluginManager::addObject() \sa PluginManager::addObject()
*/ */
......
...@@ -54,7 +54,8 @@ enum { debugLeaks = 0 }; ...@@ -54,7 +54,8 @@ enum { debugLeaks = 0 };
/*! /*!
\namespace ExtensionSystem \namespace ExtensionSystem
\brief Classes that belong to the core plugin system. \brief The ExtensionSystem namespace provides
classes that belong to the core plugin system.
The basic extension system contains of the plugin manager and its supporting classes, The basic extension system contains of the plugin manager and its supporting classes,
and the IPlugin interface that must be implemented by plugin providers. and the IPlugin interface that must be implemented by plugin providers.
...@@ -444,11 +445,19 @@ void PluginManager::startTests() ...@@ -444,11 +445,19 @@ void PluginManager::startTests()
#endif #endif
} }
/*!
* \fn bool PluginManager::runningTests() const
* \internal
*/
bool PluginManager::runningTests() const bool PluginManager::runningTests() const
{ {
return !d->testSpecs.isEmpty(); return !d->testSpecs.isEmpty();
} }
/*!
* \fn QString PluginManager::testDataDirectory() const
* \internal
*/
QString PluginManager::testDataDirectory() const QString PluginManager::testDataDirectory() const
{ {
QString s = QString::fromLocal8Bit(qgetenv("IDETESTDIR")); QString s = QString::fromLocal8Bit(qgetenv("IDETESTDIR"));
......
...@@ -221,7 +221,7 @@ QList<PluginDependency> PluginSpec::dependencies() const ...@@ -221,7 +221,7 @@ QList<PluginDependency> PluginSpec::dependencies() const
} }
/*! /*!
\fn PluginOptionDescriptions optionDescriptions() const \fn PluginSpec::PluginArgumentDescriptions PluginSpec::argumentDescriptions() const
Returns a list of descriptions of command line arguments the plugin processes. Returns a list of descriptions of command line arguments the plugin processes.
*/ */
......
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