From kde-commits  Thu Jun 30 23:50:46 2016
From: Kevin Funk <kfunk () kde ! org>
Date: Thu, 30 Jun 2016 23:50:46 +0000
To: kde-commits
Subject: [kdevelop/assistantpopup-ng] languages/clang/duchain: Minor: Turn comments into proper apidoc
Message-Id: <E1bIljK-0005Ia-Pg () code ! kde ! org>
X-MARC-Message: https://marc.info/?l=kde-commits&m=146733065612184

Git commit 77a4b337ca74794e2b56f3f39e9feb2b1e790cf9 by Kevin Funk.
Committed on 30/06/2016 at 21:53.
Pushed by kfunk into branch 'assistantpopup-ng'.

Minor: Turn comments into proper apidoc

M  +7    -9    languages/clang/duchain/unknowndeclarationproblem.cpp

http://commits.kde.org/kdevelop/77a4b337ca74794e2b56f3f39e9feb2b1e790cf9

diff --git a/languages/clang/duchain/unknowndeclarationproblem.cpp b/langua=
ges/clang/duchain/unknowndeclarationproblem.cpp
index 2f4e8b5..fee1e41 100644
--- a/languages/clang/duchain/unknowndeclarationproblem.cpp
+++ b/languages/clang/duchain/unknowndeclarationproblem.cpp
@@ -52,7 +52,7 @@
 using namespace KDevelop;
 =

 namespace {
-/* Under some conditions, such as when looking up suggestions
+/** Under some conditions, such as when looking up suggestions
  * for the undeclared namespace 'std' we will get an awful lot
  * of suggestions. This parameter limits how many suggestions
  * will pop up, as rarely more than a few will be relevant anyways
@@ -106,7 +106,7 @@ QStringList scanIncludePaths( const QString& identifier=
, const QDir& dir, int ma
     return candidates;
 }
 =

-/*
+/**
  * Find files in dir that match the given identifier. Matches common C++ h=
eader file extensions only.
  */
 QStringList scanIncludePaths( const QualifiedIdentifier& identifier, const=
 KDevelop::Path::List& includes )
@@ -122,7 +122,7 @@ QStringList scanIncludePaths( const QualifiedIdentifier=
& identifier, const KDeve
     return candidates;
 }
 =

-/*
+/**
  * Determine how much path is shared between two includes.
  *  boost/tr1/unordered_map
  *  boost/tr1/unordered_set
@@ -334,7 +334,7 @@ QStringList duchainCandidates( const QualifiedIdentifie=
r& identifier, const KDev
     return candidates;
 }
 =

-/*
+/**
  * Takes a filepath and the include paths and determines what directive to=
 use.
  */
 ClangFixit directiveForFile( const QString& includefile, const KDevelop::P=
ath::List& includepaths, const KDevelop::Path& source )
@@ -385,16 +385,14 @@ ClangFixit directiveForFile( const QString& includefi=
le, const KDevelop::Path::L
 =

 KDevelop::Path::List includePaths( const KDevelop::Path& file )
 {
-    /*
-     * Find project's custom include paths
-     */
+    // Find project's custom include paths
     const auto source =3D file.toLocalFile();
     const auto item =3D ICore::self()->projectController()->projectModel()=
->itemForPath( KDevelop::IndexedString( source ) );
 =

     return IDefinesAndIncludesManager::manager()->includes(item);
 }
 =

-/*
+/**
  * Return a list of header files viable for inclusions. All elements will =
be unique
  */
 QStringList includeFiles( const QualifiedIdentifier& identifier, const KDe=
velop::Path& file, const KDevelop::DocumentRange& range )
@@ -416,7 +414,7 @@ QStringList includeFiles( const QualifiedIdentifier& id=
entifier, const KDevelop:
     return scanIncludePaths( identifier, includes );
 }
 =

-/*
+/**
  * Construct viable forward declarations for the type name.
  *
  * Currently we're not able to determine what is namespaces, class names e=
tc