From kde-commits  Thu Sep 27 16:34:55 2018
From: Aaron Puchert <null () kde ! org>
Date: Thu, 27 Sep 2018 16:34:55 +0000
To: kde-commits
Subject: [kdevelop] plugins/custom-definesandincludes/compilerprovider: Document language type argument in IC
Message-Id: <E1g5ZFf-00068a-Tu () code ! kde ! org>
X-MARC-Message: https://marc.info/?l=kde-commits&m=153806610726554

Git commit 0fddfa4f69d6b05d53a06f2ff4d4b447a9a75363 by Aaron Puchert.
Committed on 27/09/2018 at 16:33.
Pushed by aaronpuchert into branch 'master'.

Document language type argument in ICompiler interface

This has come up in the review of D15764.

M  +2    -0    plugins/custom-definesandincludes/compilerprovider/icompiler=
.h

https://commits.kde.org/kdevelop/0fddfa4f69d6b05d53a06f2ff4d4b447a9a75363

diff --git a/plugins/custom-definesandincludes/compilerprovider/icompiler.h=
 b/plugins/custom-definesandincludes/compilerprovider/icompiler.h
index cb8bb716cc..d3645c15df 100644
--- a/plugins/custom-definesandincludes/compilerprovider/icompiler.h
+++ b/plugins/custom-definesandincludes/compilerprovider/icompiler.h
@@ -56,12 +56,14 @@ public:
     ICompiler( const QString& name, const QString& path, const QString& fa=
ctoryName, bool editable );
 =

     /**
+     * @param type Language type, must not be @ref Utils::Other.
      * @param arguments compiler command-line arguments
      * @return list of defined macros for the compiler
      */
     virtual KDevelop::Defines defines(Utils::LanguageType type, const QStr=
ing& arguments) const =3D 0;
 =

     /**
+     * @param type Language type, must not be @ref Utils::Other.
      * @param arguments compiler command-line arguments
      * @return list of include directories for the compiler
      */