Fixed warnings from clang -Wdocumentation

Change-Id: Ib3ed1d3733ccfd78780640d70e14313d0cbb101f
Reviewed-by: Erik Verbruggen <erik.verbruggen@digia.com>
This commit is contained in:
Sergey Shambir
2012-12-29 20:43:39 +04:00
committed by Erik Verbruggen
parent d94e7f259b
commit 4a6a13d30b
7 changed files with 12 additions and 15 deletions

View File

@@ -76,7 +76,7 @@ public:
* expression evaluator instance still exists, and no new call to evaluate * expression evaluator instance still exists, and no new call to evaluate
* has been made! * has been made!
* *
* @param expression The expression to evaluate. * @param utf8code The code of expression to evaluate.
* @param scope The scope enclosing the expression. * @param scope The scope enclosing the expression.
*/ */
QList<LookupItem> operator()(const QByteArray &utf8code, QList<LookupItem> operator()(const QByteArray &utf8code,

View File

@@ -353,8 +353,7 @@ int JsonSchema::itemArraySchemaSize() const
* *
* The method also marks the context as being inside an array evaluation. * The method also marks the context as being inside an array evaluation.
* *
* \param index * \return whether it was necessary to "enter" a schema for the supplied array index, false if index is out of bounds
* \return whether it was necessary to "enter" a schema for the supplied array index
*/ */
bool JsonSchema::maybeEnterNestedArraySchema(int index) bool JsonSchema::maybeEnterNestedArraySchema(int index)
{ {

View File

@@ -57,7 +57,7 @@ class Manager : public QObject
public: public:
/*! /*!
\brief \brief Creates shared instance
\param parent Parent object \param parent Parent object
*/ */
explicit Manager(QObject *parent = 0); explicit Manager(QObject *parent = 0);
@@ -132,8 +132,8 @@ public slots:
/*! /*!
\brief Open text editor for file \a fileName on line \a lineNumber and column \a column. \brief Open text editor for file \a fileName on line \a lineNumber and column \a column.
\param fileName File which has to be open \param fileName File which has to be open
\param lineNumber Line \param line Line number, 1-based
\param column Column \param column Column, 1-based
*/ */
void gotoLocation(const QString &fileName, int line = 0, int column = 0); void gotoLocation(const QString &fileName, int line = 0, int column = 0);
@@ -227,7 +227,7 @@ protected:
/*! /*!
\brief Set internal Manager state. \brief Set internal Manager state.
\param true if Manager has to be enabled, false otherwise \param state true if Manager has to be enabled, false otherwise
\sa state, stateChanged \sa state, stateChanged
*/ */
void setState(bool state); void setState(bool state);

View File

@@ -112,7 +112,7 @@ public slots:
/*! /*!
\brief Receive a new data for the tree \brief Receive a new data for the tree
\param Result - root item \param result Pointer to the Class View model root item, method does nothing if null passed
*/ */
void onDataUpdate(QSharedPointer<QStandardItem> result); void onDataUpdate(QSharedPointer<QStandardItem> result);
@@ -125,8 +125,8 @@ public slots:
protected: protected:
/*! /*!
\brief Fetch data for expanded items - to be sure that content will exist \brief Fetch data for expanded items - to be sure that content will exist
\param item \param item - does nothing if null
\param target \param target - does nothing if null
*/ */
void fetchExpandedItems(QStandardItem *item, const QStandardItem *target) const; void fetchExpandedItems(QStandardItem *item, const QStandardItem *target) const;

View File

@@ -40,7 +40,7 @@ namespace Internal {
/*! /*!
\class SymbolInformation \class SymbolInformation
\brief \brief Provides name, type and icon for single item in Class View tree
*/ */
class SymbolInformation class SymbolInformation

View File

@@ -82,7 +82,7 @@ public:
/*! /*!
\brief Set symbol information to the \a QStandardItem \brief Set symbol information to the \a QStandardItem
\param information \param information Provides name, type and icon
\param item Item \param item Item
\return Filled item \return Filled item
*/ */

View File

@@ -60,9 +60,7 @@ protected:
\param actionId Action's internal id \param actionId Action's internal id
\param id Command id \param id Command id
\param title Action's title \param title Action's title
\param context Current context \param key Key sequence for the commands
\param key Key sequence for the command
\return Created and registered action, 0 if something goes wrong
*/ */
void registerNewAction(int actionId, const Core::Id &id, const QString &title, void registerNewAction(int actionId, const Core::Id &id, const QString &title,
const QKeySequence &key); const QKeySequence &key);