Commit 3d7874aa authored by Kevin Funk's avatar Kevin Funk
Browse files

Fix -Wdocumentation warnings

parent ba5c2f56
......@@ -47,10 +47,10 @@ public:
KTextEditor::Range displayRange() const override;
private:
///Compare @param newSignature to m_oldSignature and put differences in oldPositions
///Compare @a newSignature to m_oldSignature and put differences in @a oldPositions
///@returns whether or not there are any differences
bool getSignatureChanges(const Signature &newSignature, QList<int> &oldPositions) const;
///Set default params in @param newSignature based on m_oldSignature's defaults and @param oldPositions
///Set default params in @a newSignature based on m_oldSignature's defaults and @a oldPositions
void setDefaultParams(Signature &newSignature, const QList<int> &oldPositions) const;
///@returns RenameActions for each parameter in newSignature that has been renamed
QList<KDevelop::RenameAction*> getRenameActions(const Signature &newSignature, const QList<int> &oldPositions) const;
......
......@@ -50,7 +50,7 @@ KDevelop::DeclarationPointer findDeclaration(CXCursor cursor, const IncludeFileC
KDevelop::DeclarationPointer findDeclaration(CXType type, const IncludeFileContexts& includes);
/**
* Try to look up the first reachable forward declaration for type @p type
* Try to look up the first reachable forward declaration for type @a type
*
* @param context The context where this search is happening
* @param cursor The location from which we're searching
......@@ -63,15 +63,15 @@ KDevelop::DeclarationPointer findForwardDeclaration(CXType type, KDevelop::DUCon
KDevelop::RangeInRevision cursorSpellingNameRange(CXCursor cursor, const KDevelop::Identifier& id);
/**
* @returns all the Imports for each file in the @param tu
* @returns all the Imports for each file in the @a tu
*/
KDEVCLANGPRIVATE_EXPORT Imports tuImports(CXTranslationUnit tu);
/**
* Recursively builds a duchain with the specified @param features for the
* @param file and each of its @param imports using the TU from @param session.
* The resulting contexts are placed in @param includedFiles.
* @returns the context created for @param file
* Recursively builds a duchain with the specified @a features for the
* @a file and each of its @a imports using the TU from @a session.
* The resulting contexts are placed in @a includedFiles.
* @returns the context created for @a file
*/
KDEVCLANGPRIVATE_EXPORT KDevelop::ReferencedTopDUContext buildDUChain(
CXFile file, const Imports& imports, const ParseSession& session,
......@@ -89,12 +89,12 @@ QStringList headerExtensions();
QStringList sourceExtensions();
/**
* @return True if the given file @p path has the extension of a C++ source file
* @return True if the given file @a path has the extension of a C++ source file
*/
KDEVCLANGPRIVATE_EXPORT bool isSource(const QString& path);
/**
* @return True if the given file @p path has the extension of a C++ header file
* @return True if the given file @a path has the extension of a C++ header file
*/
KDEVCLANGPRIVATE_EXPORT bool isHeader(const QString& path);
......
......@@ -73,7 +73,6 @@ public:
/**
* @brief Set the prototype context of this function
* @param own True if this function declaration must be set as the owner of context
*
* @note The DUChain must be write-locked
*/
......@@ -93,4 +92,4 @@ private:
DUCHAIN_DECLARE_TYPE(QmlJS::FunctionDeclaration)
#endif
\ No newline at end of file
#endif
......@@ -173,9 +173,6 @@ public:
/**
* Schedule a document for update using the default flags of QML/JS
*
* @return The actual priority of the file being queued (this priority can
* only be lower then @p priority)
*/
static void scheduleForParsing(const KDevelop::IndexedString& url, int priority);
......
#ifndef KDETEST_H
#define KDETEST_h
#define KDETEST_H
#include <QtCore/QObject>
......
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