Commit 81fc8ff2 authored by Orgad Shaneh's avatar Orgad Shaneh Committed by Orgad Shaneh
Browse files

Doc: Remove \fn lines adjacent to functions



They are unneeded, some of them are unmaintained

Change-Id: I0ad87e152d8e2328b486b2f904f7cf9613004afe
Reviewed-by: default avatarEike Ziller <eike.ziller@digia.com>
parent 506b4ca9
......@@ -46,7 +46,6 @@
using namespace ExtensionSystem;
/*!
\fn PluginDetailsView::PluginDetailsView(QWidget *parent)
Constructs a new view with given \a parent widget.
*/
PluginDetailsView::PluginDetailsView(QWidget *parent)
......@@ -57,7 +56,6 @@ PluginDetailsView::PluginDetailsView(QWidget *parent)
}
/*!
\fn PluginDetailsView::~PluginDetailsView()
\internal
*/
PluginDetailsView::~PluginDetailsView()
......@@ -66,7 +64,6 @@ PluginDetailsView::~PluginDetailsView()
}
/*!
\fn void PluginDetailsView::update(PluginSpec *spec)
Reads the given \a spec and displays its values
in this PluginDetailsView.
*/
......
......@@ -46,7 +46,6 @@
using namespace ExtensionSystem;
/*!
\fn PluginErrorView::PluginErrorView(QWidget *parent)
Constructs a new error view with given \a parent widget.
*/
PluginErrorView::PluginErrorView(QWidget *parent)
......@@ -57,7 +56,6 @@ PluginErrorView::PluginErrorView(QWidget *parent)
}
/*!
\fn PluginErrorView::~PluginErrorView()
\internal
*/
PluginErrorView::~PluginErrorView()
......@@ -66,7 +64,6 @@ PluginErrorView::~PluginErrorView()
}
/*!
\fn void PluginErrorView::update(PluginSpec *spec)
Reads the given \a spec and displays its state and
error information in this PluginErrorView.
*/
......
......@@ -245,7 +245,6 @@ static bool lessThanByPluginName(const PluginSpec *one, const PluginSpec *two)
PluginManager *PluginManager::m_instance = 0;
/*!
\fn PluginManager *PluginManager::instance()
Get the unique plugin manager instance.
*/
PluginManager *PluginManager::instance()
......@@ -254,7 +253,6 @@ PluginManager *PluginManager::instance()
}
/*!
\fn PluginManager::PluginManager()
Create a plugin manager. Should be done only once per application.
*/
PluginManager::PluginManager()
......@@ -264,7 +262,6 @@ PluginManager::PluginManager()
}
/*!
\fn PluginManager::~PluginManager()
\internal
*/
PluginManager::~PluginManager()
......@@ -274,7 +271,6 @@ PluginManager::~PluginManager()
}
/*!
\fn void PluginManager::addObject(QObject *obj)
Add the given object \a obj to the object pool, so it can be retrieved again from the pool by type.
The plugin manager does not do any memory management - added objects
must be removed from the pool and deleted manually by whoever is responsible for the object.
......@@ -291,7 +287,6 @@ void PluginManager::addObject(QObject *obj)
}
/*!
\fn void PluginManager::removeObject(QObject *obj)
Emits aboutToRemoveObject() and removes the object \a obj from the object pool.
\sa PluginManager::addObject()
*/
......@@ -301,7 +296,6 @@ void PluginManager::removeObject(QObject *obj)
}
/*!
\fn QList<QObject *> PluginManager::allObjects() const
Retrieve the list of all objects in the pool, unfiltered.
Usually clients do not need to call this.
\sa PluginManager::getObject()
......@@ -313,7 +307,6 @@ QList<QObject *> PluginManager::allObjects()
}
/*!
\fn void PluginManager::loadPlugins()
Tries to load all the plugins that were previously found when
setting the plugin search paths. The plugin specs of the plugins
can be used to retrieve error and state information about individual plugins.
......@@ -327,7 +320,6 @@ void PluginManager::loadPlugins()
}
/*!
\fn bool PluginManager::hasError() const
Returns true if any plugin has errors even though it is enabled.
Most useful to call after loadPlugins().
*/
......@@ -342,7 +334,6 @@ bool PluginManager::hasError()
}
/*!
\fn void PluginManager::shutdown()
Shuts down and deletes all plugins.
*/
void PluginManager::shutdown()
......@@ -351,7 +342,6 @@ void PluginManager::shutdown()
}
/*!
\fn QStringList PluginManager::pluginPaths() const
The list of paths were the plugin manager searches for plugins.
\sa setPluginPaths()
......@@ -362,7 +352,6 @@ QStringList PluginManager::pluginPaths()
}
/*!
\fn void PluginManager::setPluginPaths(const QStringList &paths)
Sets the plugin search paths, i.e. the file system paths where the plugin manager
looks for plugin descriptions. All given \a paths and their sub directory trees
are searched for plugin xml description files.
......@@ -376,7 +365,6 @@ void PluginManager::setPluginPaths(const QStringList &paths)
}
/*!
\fn QString PluginManager::fileExtension() const
The file extension of plugin description files.
The default is "xml".
......@@ -388,7 +376,6 @@ QString PluginManager::fileExtension()
}
/*!
\fn void PluginManager::setFileExtension(const QString &extension)
Sets the file extension of plugin description files.
The default is "xml".
At the moment this must be called before setPluginPaths() is called.
......@@ -439,7 +426,6 @@ void PluginManager::writeSettings()
}
/*!
\fn QStringList PluginManager::arguments() const
The arguments left over after parsing (Neither startup nor plugin
arguments). Typically, this will be the list of files to open.
*/
......@@ -449,7 +435,6 @@ QStringList PluginManager::arguments()
}
/*!
\fn QList<PluginSpec *> PluginManager::plugins() const
List of all plugin specifications that have been found in the plugin search paths.
This list is valid directly after the setPluginPaths() call.
The plugin specifications contain the information from the plugins' xml description files
......@@ -468,9 +453,9 @@ QHash<QString, PluginCollection *> PluginManager::pluginCollections()
return m_instance->d->pluginCategories;
}
/*!
\fn QString PluginManager::serializedArguments() const
static const char argumentKeywordC[] = ":arguments";
/*!
Serialize plugin options and arguments for sending in a single string
via QtSingleApplication:
":myplugin|-option1|-option2|:arguments|argument1|argument2",
......@@ -478,9 +463,6 @@ QHash<QString, PluginCollection *> PluginManager::pluginCollections()
\sa setPluginPaths()
*/
static const char argumentKeywordC[] = ":arguments";
QString PluginManager::serializedArguments()
{
const QChar separator = QLatin1Char('|');
......@@ -532,8 +514,6 @@ static QStringList subList(const QStringList &in, const QString &key)
}
/*!
\fn PluginManager::remoteArguments(const QString &argument, QObject *socket)
Parses the options encoded by serializedArguments() const
and passes them on to the respective plugins along with the arguments.
......@@ -562,7 +542,6 @@ void PluginManager::remoteArguments(const QString &serializedArgument, QObject *
}
/*!
\fn bool PluginManager::parseOptions(const QStringList &args, const QMap<QString, bool> &appOptions, QMap<QString, QString> *foundAppOptions, QString *errorString)
Takes the list of command line options in \a args and parses them.
The plugin manager itself might process some options itself directly (-noload <plugin>), and
adds options that are registered by plugins to their plugin specs.
......@@ -611,8 +590,6 @@ static inline void formatOption(QTextStream &str,
}
/*!
\fn static PluginManager::formatOptions(QTextStream &str, int optionIndentation, int descriptionIndentation)
Format the startup options of the plugin manager for command line help.
*/
......@@ -638,8 +615,6 @@ void PluginManager::formatOptions(QTextStream &str, int optionIndentation, int d
}
/*!
\fn PluginManager::formatPluginOptions(QTextStream &str, int optionIndentation, int descriptionIndentation) const
Format the plugin options of the plugin specs for command line help.
*/
......@@ -660,11 +635,8 @@ void PluginManager::formatPluginOptions(QTextStream &str, int optionIndentation,
}
/*!
\fn PluginManager::formatPluginVersions(QTextStream &str) const
Format the version of the plugin specs for command line help.
*/
void PluginManager::formatPluginVersions(QTextStream &str)
{
const PluginSpecSet::const_iterator cend = m_instance->d->pluginSpecs.constEnd();
......@@ -747,7 +719,6 @@ void PluginManager::startTests()
}
/*!
* \fn bool PluginManager::runningTests() const
* \internal
*/
bool PluginManager::testRunRequested()
......@@ -756,7 +727,6 @@ bool PluginManager::testRunRequested()
}
/*!
* \fn QString PluginManager::testDataDirectory() const
* \internal
*/
QString PluginManager::testDataDirectory()
......@@ -772,8 +742,6 @@ QString PluginManager::testDataDirectory()
}
/*!
\fn void PluginManager::profilingReport(const char *what, const PluginSpec *spec = 0)
Create a profiling entry showing the elapsed time if profiling is activated.
*/
......@@ -784,8 +752,6 @@ void PluginManager::profilingReport(const char *what, const PluginSpec *spec)
/*!
\fn void PluginManager::loadQueue()
Returns a list of plugins in load order.
*/
QList<PluginSpec *> PluginManager::loadQueue()
......@@ -796,7 +762,6 @@ QList<PluginSpec *> PluginManager::loadQueue()
//============PluginManagerPrivate===========
/*!
\fn PluginSpec *PluginManagerPrivate::createSpec()
\internal
*/
PluginSpec *PluginManagerPrivate::createSpec()
......@@ -805,7 +770,6 @@ PluginSpec *PluginManagerPrivate::createSpec()
}
/*!
\fn void PluginManagerPrivate::setSettings(QSettings *settings)
\internal
*/
void PluginManagerPrivate::setSettings(QSettings *s)
......@@ -830,7 +794,6 @@ void PluginManagerPrivate::setGlobalSettings(QSettings *s)
}
/*!
\fn PluginSpecPrivate *PluginManagerPrivate::privateSpec(PluginSpec *spec)
\internal
*/
PluginSpecPrivate *PluginManagerPrivate::privateSpec(PluginSpec *spec)
......@@ -859,7 +822,6 @@ void PluginManagerPrivate::nextDelayedInitialize()
}
/*!
\fn PluginManagerPrivate::PluginManagerPrivate(PluginManager *pluginManager)
\internal
*/
PluginManagerPrivate::PluginManagerPrivate(PluginManager *pluginManager) :
......@@ -876,7 +838,6 @@ PluginManagerPrivate::PluginManagerPrivate(PluginManager *pluginManager) :
/*!
\fn PluginManagerPrivate::~PluginManagerPrivate()
\internal
*/
PluginManagerPrivate::~PluginManagerPrivate()
......@@ -886,7 +847,6 @@ PluginManagerPrivate::~PluginManagerPrivate()
}
/*!
\fn void PluginManagerPrivate::writeSettings()
\internal
*/
void PluginManagerPrivate::writeSettings()
......@@ -907,7 +867,6 @@ void PluginManagerPrivate::writeSettings()
}
/*!
\fn void PluginManagerPrivate::readSettings()
\internal
*/
void PluginManagerPrivate::readSettings()
......@@ -921,7 +880,6 @@ void PluginManagerPrivate::readSettings()
}
/*!
\fn void PluginManagerPrivate::stopAll()
\internal
*/
void PluginManagerPrivate::stopAll()
......@@ -938,7 +896,6 @@ void PluginManagerPrivate::stopAll()
}
/*!
\fn void PluginManagerPrivate::deleteAll()
\internal
*/
void PluginManagerPrivate::deleteAll()
......@@ -952,7 +909,6 @@ void PluginManagerPrivate::deleteAll()
}
/*!
\fn void PluginManagerPrivate::addObject(QObject *obj)
\internal
*/
void PluginManagerPrivate::addObject(QObject *obj)
......@@ -984,7 +940,6 @@ void PluginManagerPrivate::addObject(QObject *obj)
}
/*!
\fn void PluginManagerPrivate::removeObject(QObject *obj)
\internal
*/
void PluginManagerPrivate::removeObject(QObject *obj)
......@@ -1008,7 +963,6 @@ void PluginManagerPrivate::removeObject(QObject *obj)
}
/*!
\fn void PluginManagerPrivate::loadPlugins()
\internal
*/
void PluginManagerPrivate::loadPlugins()
......@@ -1039,7 +993,6 @@ void PluginManagerPrivate::loadPlugins()
}
/*!
\fn void PluginManagerPrivate::shutdown()
\internal
*/
void PluginManagerPrivate::shutdown()
......@@ -1055,7 +1008,6 @@ void PluginManagerPrivate::shutdown()
}
/*!
\fn void PluginManagerPrivate::asyncShutdownFinished()
\internal
*/
void PluginManagerPrivate::asyncShutdownFinished()
......@@ -1068,7 +1020,6 @@ void PluginManagerPrivate::asyncShutdownFinished()
}
/*!
\fn void PluginManagerPrivate::loadQueue()
\internal
*/
QList<PluginSpec *> PluginManagerPrivate::loadQueue()
......@@ -1082,7 +1033,6 @@ QList<PluginSpec *> PluginManagerPrivate::loadQueue()
}
/*!
\fn bool PluginManagerPrivate::loadQueue(PluginSpec *spec, QList<PluginSpec *> &queue, QList<PluginSpec *> &circularityCheckQueue)
\internal
*/
bool PluginManagerPrivate::loadQueue(PluginSpec *spec, QList<PluginSpec *> &queue,
......@@ -1125,7 +1075,6 @@ bool PluginManagerPrivate::loadQueue(PluginSpec *spec, QList<PluginSpec *> &queu
}
/*!
\fn void PluginManagerPrivate::loadPlugin(PluginSpec *spec, PluginSpec::State destState)
\internal
*/
void PluginManagerPrivate::loadPlugin(PluginSpec *spec, PluginSpec::State destState)
......@@ -1192,7 +1141,6 @@ void PluginManagerPrivate::loadPlugin(PluginSpec *spec, PluginSpec::State destSt
}
/*!
\fn void PluginManagerPrivate::setPluginPaths(const QStringList &paths)
\internal
*/
void PluginManagerPrivate::setPluginPaths(const QStringList &paths)
......@@ -1203,7 +1151,6 @@ void PluginManagerPrivate::setPluginPaths(const QStringList &paths)
}
/*!
\fn void PluginManagerPrivate::readPluginPaths()
\internal
*/
void PluginManagerPrivate::readPluginPaths()
......@@ -1361,7 +1308,6 @@ void PluginManagerPrivate::profilingSummary() const
}
/*!
\fn void PluginManager::getObjectByName(const QString &name) const
\brief Retrieves one object with a given name from the object pool.
\sa addObject()
*/
......@@ -1378,7 +1324,6 @@ QObject *PluginManager::getObjectByName(const QString &name)
}
/*!
\fn void PluginManager::getObjectByClassName(const QString &className) const
Retrieves one object inheriting a class with a given name from the object pool.
\sa addObject()
*/
......
......@@ -145,7 +145,6 @@ using namespace ExtensionSystem;
using namespace ExtensionSystem::Internal;
/*!
\fn uint qHash(const ExtensionSystem::PluginDependency &value)
\internal
*/
uint ExtensionSystem::qHash(const ExtensionSystem::PluginDependency &value)
......@@ -154,7 +153,6 @@ uint ExtensionSystem::qHash(const ExtensionSystem::PluginDependency &value)
}
/*!
\fn bool PluginDependency::operator==(const PluginDependency &other) const
\internal
*/
bool PluginDependency::operator==(const PluginDependency &other) const
......@@ -163,7 +161,6 @@ bool PluginDependency::operator==(const PluginDependency &other) const
}
/*!
\fn PluginSpec::PluginSpec()
\internal
*/
PluginSpec::PluginSpec()
......@@ -172,7 +169,6 @@ PluginSpec::PluginSpec()
}
/*!
\fn PluginSpec::~PluginSpec()
\internal
*/
PluginSpec::~PluginSpec()
......@@ -182,7 +178,6 @@ PluginSpec::~PluginSpec()
}
/*!
\fn QString PluginSpec::name() const
The plugin name. This is valid after the PluginSpec::Read state is reached.
*/
QString PluginSpec::name() const
......@@ -191,7 +186,6 @@ QString PluginSpec::name() const
}
/*!
\fn QString PluginSpec::version() const
The plugin version. This is valid after the PluginSpec::Read state is reached.
*/
QString PluginSpec::version() const
......@@ -200,7 +194,6 @@ QString PluginSpec::version() const
}
/*!
\fn QString PluginSpec::compatVersion() const
The plugin compatibility version. This is valid after the PluginSpec::Read state is reached.
*/
QString PluginSpec::compatVersion() const
......@@ -209,7 +202,6 @@ QString PluginSpec::compatVersion() const
}
/*!
\fn QString PluginSpec::vendor() const
The plugin vendor. This is valid after the PluginSpec::Read state is reached.
*/
QString PluginSpec::vendor() const
......@@ -218,7 +210,6 @@ QString PluginSpec::vendor() const
}
/*!
\fn QString PluginSpec::copyright() const
The plugin copyright. This is valid after the PluginSpec::Read state is reached.
*/
QString PluginSpec::copyright() const
......@@ -227,7 +218,6 @@ QString PluginSpec::copyright() const
}
/*!
\fn QString PluginSpec::license() const
The plugin license. This is valid after the PluginSpec::Read state is reached.
*/
QString PluginSpec::license() const
......@@ -236,7 +226,6 @@ QString PluginSpec::license() const
}
/*!
\fn QString PluginSpec::description() const
The plugin description. This is valid after the PluginSpec::Read state is reached.
*/
QString PluginSpec::description() const
......@@ -245,7 +234,6 @@ QString PluginSpec::description() const
}
/*!
\fn QString PluginSpec::url() const
The plugin url where you can find more information about the plugin. This is valid after the PluginSpec::Read state is reached.
*/
QString PluginSpec::url() const
......@@ -254,7 +242,6 @@ QString PluginSpec::url() const
}
/*!
\fn QString PluginSpec::category() const
The category that the plugin belongs to. Categories are groups of plugins which allow for keeping them together in the UI.
Returns an empty string if the plugin does not belong to a category.
*/
......@@ -264,7 +251,6 @@ QString PluginSpec::category() const
}
/*!
\fn bool PluginSpec::isExperimental() const
Returns if the plugin has its experimental flag set.
*/
bool PluginSpec::isExperimental() const
......@@ -283,7 +269,6 @@ bool PluginSpec::isDisabledByDefault() const
}
/*!
\fn bool PluginSpec::isEnabledInSettings() const
Returns if the plugin should be loaded at startup. True by default
The user can change it from the Plugin settings.
Note: That this function returns true even if a plugin is disabled because
......@@ -295,7 +280,6 @@ bool PluginSpec::isEnabledInSettings() const
}
/*!
\fn bool PluginSpec::isEffectivelyEnabled() const
Returns if the plugin is loaded at startup.
\see PluginSpec::isEnabled
*/
......@@ -307,7 +291,6 @@ bool PluginSpec::isEffectivelyEnabled() const
}
/*!
\fn bool PluginSpec::isDisabledIndirectly() const
Returns true if loading was not done due to user unselecting this plugin or its dependencies.
*/
bool PluginSpec::isDisabledIndirectly() const
......@@ -316,7 +299,6 @@ bool PluginSpec::isDisabledIndirectly() const
}
/*!
\fn bool PluginSpec::isForceEnabled() const
Returns if the plugin is enabled via the -load option on the command line.
*/
bool PluginSpec::isForceEnabled() const
......@@ -325,7 +307,6 @@ bool PluginSpec::isForceEnabled() const
}
/*!
\fn bool PluginSpec::isForceDisabled() const
Returns if the plugin is disabled via the -noload option on the command line.
*/
bool PluginSpec::isForceDisabled() const
......@@ -334,7 +315,6 @@ bool PluginSpec::isForceDisabled() const
}
/*!
\fn QList<PluginDependency> PluginSpec::dependencies() const
The plugin dependencies. This is valid after the PluginSpec::Read state is reached.
*/
QList<PluginDependency> PluginSpec::dependencies() const
......@@ -343,7 +323,6 @@ QList<PluginDependency> PluginSpec::dependencies() const
}
/*!
\fn PluginSpec::PluginArgumentDescriptions PluginSpec::argumentDescriptions() const
Returns a list of descriptions of command line arguments the plugin processes.
*/
......@@ -353,7 +332,6 @@ PluginSpec::PluginArgumentDescriptions PluginSpec::argumentDescriptions() const
}
/*!
\fn QString PluginSpec::location() const
The absolute path to the directory containing the plugin xml description file
this PluginSpec corresponds to.
*/
......@@ -363,7 +341,6 @@ QString PluginSpec::location() const
}
/*!
\fn QString PluginSpec::filePath() const
The absolute path to the plugin xml description file (including the file name)
this PluginSpec corresponds to.
*/
......@@ -373,7 +350,6 @@ QString PluginSpec::filePath() const
}
/*!
\fn QStringList PluginSpec::arguments() const
Command line arguments specific to that plugin. Set at startup
*/
......@@ -383,7 +359,6 @@ QStringList PluginSpec::arguments() const
}
/*!
\fn void PluginSpec::setArguments(const QStringList &arguments)
Set the command line arguments specific to that plugin to \a arguments.
*/
......@@ -393,7 +368,6 @@ void PluginSpec::setArguments(const QStringList &arguments)
}
/*!
\fn PluginSpec::addArgument(const QString &argument)
Adds \a argument to the command line arguments specific to that plugin.
*/
......@@ -404,7 +378,6 @@ void PluginSpec::addArgument(const QString &argument)
/*!
\fn PluginSpec::State PluginSpec::state() const
The state in which the plugin currently is.
See the description of the PluginSpec::State enum for details.
*/
......@@ -414,7 +387,6 @@ PluginSpec::State PluginSpec::state() const
}
/*!
\fn bool PluginSpec::hasError() const
Returns whether an error occurred while reading/starting the plugin.
*/
bool PluginSpec::hasError() const
......@@ -423,7 +395,6 @@ bool PluginSpec::hasError() const
}
/*!
\fn QString PluginSpec::errorString() const
Detailed, possibly multi-line, error description in case of an error.
*/
QString PluginSpec::errorString() const
......@@ -432,7 +403,6 @@ QString PluginSpec::errorString() const
}
/*!
\fn bool PluginSpec::provides(const QString &pluginName, const QString &version) const
Returns if this plugin can be used to fill in a dependency of the given
\a pluginName and \a version.
......@@ -444,7 +414,6 @@ bool PluginSpec::provides(const QString &pluginName, const QString &version) con
}
/*!
\fn IPlugin *PluginSpec::plugin() const
The corresponding IPlugin instance, if the plugin library has already been successfully loaded,
i.e. the PluginSpec::Loaded state is reached.
*/
......@@ -454,7 +423,6 @@ IPlugin *PluginSpec::plugin() const
}
/*!
\fn QList<PluginSpec *> PluginSpec::dependencySpecs() const
Returns the list of dependencies, already resolved to existing plugin specs.
Valid if PluginSpec::Resolved state is reached.