diff options
| author | Leena Miettinen <[email protected]> | 2013-05-24 17:35:14 +0200 |
|---|---|---|
| committer | Erik Verbruggen <[email protected]> | 2013-05-29 14:32:07 +0200 |
| commit | 3f843aca67b70fde29934061552860c45b5678b1 (patch) | |
| tree | 44328fd0dee4a786eae59235216cc7a7f5b95de5 /src/plugins/classview/classviewplugin.cpp | |
| parent | 5b268822cf8db18ec2e3eb8d57296c549378a971 (diff) | |
Doc: move Class View plugin docs to .cpp files.
QDoc does not find docs in the .h files.
Use \brief only for namespaces, classes, enums, and properties.
Use standard wording for \brief and \fn.
Use \a and \c according to guidelines.
Fix grammar and style.
Change-Id: Ib685a03c97ef38661ecc156f61d70085514357fc
Reviewed-by: Erik Verbruggen <[email protected]>
Diffstat (limited to 'src/plugins/classview/classviewplugin.cpp')
| -rw-r--r-- | src/plugins/classview/classviewplugin.cpp | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/src/plugins/classview/classviewplugin.cpp b/src/plugins/classview/classviewplugin.cpp index d5f552f7a6a..db233e7954e 100644 --- a/src/plugins/classview/classviewplugin.cpp +++ b/src/plugins/classview/classviewplugin.cpp @@ -38,6 +38,14 @@ namespace Internal { ///////////////////////////////// Plugin ////////////////////////////////// +/*! + \class Plugin + \brief The Plugin class is the base class for the Class View plugin. + + The Class View shows the namespace and class hierarchy of the currently open + projects in the sidebar. +*/ + bool Plugin::initialize(const QStringList &arguments, QString *errorMessage) { Q_UNUSED(arguments) |