[clang-tools-extra] 229d78d - [clang-doc] Use QualName in Markdown output
via cfe-commits
cfe-commits at lists.llvm.org
Fri Dec 13 09:58:12 PST 2024
Author: Paul Kirth
Date: 2024-12-13T09:58:08-08:00
New Revision: 229d78de31467f623e33716a30cb0c6d285d7683
URL: https://github.com/llvm/llvm-project/commit/229d78de31467f623e33716a30cb0c6d285d7683
DIFF: https://github.com/llvm/llvm-project/commit/229d78de31467f623e33716a30cb0c6d285d7683.diff
LOG: [clang-doc] Use QualName in Markdown output
QualName will provide the more useful typename when the type is
templated.
Fixes #67549
Reviewers: petrhosek, PeterChou1
Reviewed By: petrhosek
Pull Request: https://github.com/llvm/llvm-project/pull/119815
Added:
Modified:
clang-tools-extra/clang-doc/MDGenerator.cpp
clang-tools-extra/test/clang-doc/templates.cpp
Removed:
################################################################################
diff --git a/clang-tools-extra/clang-doc/MDGenerator.cpp b/clang-tools-extra/clang-doc/MDGenerator.cpp
index 795eb4b904e3ef..28b645cf021ddf 100644
--- a/clang-tools-extra/clang-doc/MDGenerator.cpp
+++ b/clang-tools-extra/clang-doc/MDGenerator.cpp
@@ -157,17 +157,17 @@ static void genMarkdown(const ClangDocContext &CDCtx, const FunctionInfo &I,
for (const auto &N : I.Params) {
if (!First)
Stream << ", ";
- Stream << N.Type.Name + " " + N.Name;
+ Stream << N.Type.QualName + " " + N.Name;
First = false;
}
writeHeader(I.Name, 3, OS);
std::string Access = getAccessSpelling(I.Access).str();
if (Access != "")
- writeLine(genItalic(Access + " " + I.ReturnType.Type.Name + " " + I.Name +
- "(" + Stream.str() + ")"),
+ writeLine(genItalic(Access + " " + I.ReturnType.Type.QualName + " " +
+ I.Name + "(" + Stream.str() + ")"),
OS);
else
- writeLine(genItalic(I.ReturnType.Type.Name + " " + I.Name + "(" +
+ writeLine(genItalic(I.ReturnType.Type.QualName + " " + I.Name + "(" +
Stream.str() + ")"),
OS);
if (I.DefLoc)
diff --git a/clang-tools-extra/test/clang-doc/templates.cpp b/clang-tools-extra/test/clang-doc/templates.cpp
index 749d040489a0b4..5229063f7ee236 100644
--- a/clang-tools-extra/test/clang-doc/templates.cpp
+++ b/clang-tools-extra/test/clang-doc/templates.cpp
@@ -150,7 +150,7 @@ tuple<int,int,bool> func_with_tuple_param(tuple<int,int,bool> t){ return t;}
// YAML-NEXT: ...
// MD: ### func_with_tuple_param
-// MD: *tuple func_with_tuple_param(tuple t)*
+// MD: *tuple<int, int, _Bool> func_with_tuple_param(tuple<int, int, _Bool> t)*
// MD: *Defined at {{.*}}templates.cpp#[[# @LINE - 44]]*
// MD: A function with a tuple parameter
// MD: **t** The input to func_with_tuple_param
More information about the cfe-commits
mailing list