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 <erik.verbruggen@digia.com>
This commit is contained in:
Leena Miettinen
2013-05-24 17:35:14 +02:00
committed by Erik Verbruggen
parent 5b268822cf
commit 3f843aca67
20 changed files with 610 additions and 492 deletions

View File

@@ -41,66 +41,25 @@ QT_FORWARD_DECLARE_CLASS(QStandardItem)
namespace ClassView {
namespace Internal {
/*!
\class Utils
\brief Some common utils
*/
class Utils
{
//! Private constructor
Utils();
public:
/*!
\brief convert internal location container to QVariant compatible
\param locations Set of SymbolLocations
\return List of variant locations (can be added to an item's data)
*/
static QList<QVariant> locationsToRole(const QSet<SymbolLocation> &locations);
/*!
\brief convert QVariant location container to internal
\param locations List of variant locations (from an item's data)
\return Set of SymbolLocations
*/
static QSet<SymbolLocation> roleToLocations(const QList<QVariant> &locations);
/*!
\brief Returns sort order value for the icon type
\param iconType Icon type
\return Sort order value for the provided icon type
*/
static int iconTypeSortOrder(int iconType);
/*!
\brief Get symbol information for the \a QStandardItem
\param item Item
\return Filled symbol information.
*/
static SymbolInformation symbolInformationFromItem(const QStandardItem *item);
/*!
\brief Set symbol information to the \a QStandardItem
\param information Provides name, type and icon
\param item Item
\return Filled item
*/
static QStandardItem *setSymbolInformationToItem(const SymbolInformation &information,
QStandardItem *item);
/*!
\brief Update an item to the target. (sorted, for fetching)
\param item Source item
\param target Target item
*/
static void fetchItemToTarget(QStandardItem *item, const QStandardItem *target);
/*!
\brief Move an item to the target. (sorted)
\param item Source item
\param target Target item
*/
static void moveItemToTarget(QStandardItem *item, const QStandardItem *target);
};