[PATCH] D156322: Outputs parameter comments using clang-doc and markdown generator

2023-07-26 Thread Arnaud Botella via Phabricator via cfe-commits 
BotellaA created this revision.
BotellaA added a reviewer: juliehockett.
BotellaA added a project: clang-tools-extra.
Herald added a project: All.
BotellaA requested review of this revision.
Herald added a subscriber: cfe-commits.

Current implementation outputs the parameter name when used with @param (or 
@tparam) doxygen tag but not the comment itself.


https://reviews.llvm.org/D156322

Files:
  clang-tools-extra/clang-doc/MDGenerator.cpp


Index: clang-tools-extra/clang-doc/MDGenerator.cpp
===
--- clang-tools-extra/clang-doc/MDGenerator.cpp
+++ clang-tools-extra/clang-doc/MDGenerator.cpp
@@ -82,10 +82,14 @@
 OS << genEmphasis(I.Name) << " " << I.Text;
   } else if (I.Kind == "ParamCommandComment") {
 std::string Direction = I.Explicit ? (" " + I.Direction).str() : "";
-OS << genEmphasis(I.ParamName) << I.Text << Direction << "\n\n";
+OS << genEmphasis(I.ParamName) << I.Text << Direction;
+for (const auto &Child : I.Children)
+  writeDescription(*Child, OS);
   } else if (I.Kind == "TParamCommandComment") {
 std::string Direction = I.Explicit ? (" " + I.Direction).str() : "";
-OS << genEmphasis(I.ParamName) << I.Text << Direction << "\n\n";
+OS << genEmphasis(I.ParamName) << I.Text << Direction;
+for (const auto &Child : I.Children)
+  writeDescription(*Child, OS);
   } else if (I.Kind == "VerbatimBlockComment") {
 for (const auto &Child : I.Children)
   writeDescription(*Child, OS);


Index: clang-tools-extra/clang-doc/MDGenerator.cpp
===
--- clang-tools-extra/clang-doc/MDGenerator.cpp
+++ clang-tools-extra/clang-doc/MDGenerator.cpp
@@ -82,10 +82,14 @@
 OS << genEmphasis(I.Name) << " " << I.Text;
   } else if (I.Kind == "ParamCommandComment") {
 std::string Direction = I.Explicit ? (" " + I.Direction).str() : "";
-OS << genEmphasis(I.ParamName) << I.Text << Direction << "\n\n";
+OS << genEmphasis(I.ParamName) << I.Text << Direction;
+for (const auto &Child : I.Children)
+  writeDescription(*Child, OS);
   } else if (I.Kind == "TParamCommandComment") {
 std::string Direction = I.Explicit ? (" " + I.Direction).str() : "";
-OS << genEmphasis(I.ParamName) << I.Text << Direction << "\n\n";
+OS << genEmphasis(I.ParamName) << I.Text << Direction;
+for (const auto &Child : I.Children)
+  writeDescription(*Child, OS);
   } else if (I.Kind == "VerbatimBlockComment") {
 for (const auto &Child : I.Children)
   writeDescription(*Child, OS);
___
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

[PATCH] D156322: Outputs parameter comments using clang-doc and markdown generator

2023-07-26 Thread Arnaud Botella via Phabricator via cfe-commits 
BotellaA updated this revision to Diff 544477.
BotellaA added a comment.

Updated the expected result in the MD generator test.


CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D156322/new/

https://reviews.llvm.org/D156322

Files:
  clang-tools-extra/clang-doc/MDGenerator.cpp
  clang-tools-extra/unittests/clang-doc/MDGeneratorTest.cpp


Index: clang-tools-extra/unittests/clang-doc/MDGeneratorTest.cpp
===
--- clang-tools-extra/unittests/clang-doc/MDGeneratorTest.cpp
+++ clang-tools-extra/unittests/clang-doc/MDGeneratorTest.cpp
@@ -347,9 +347,9 @@
 
  The description continues.
 
-**I** [out]
+**I** [out] is a parameter.
 
-**J**
+**J** is a parameter.
 
 **return**void
 
Index: clang-tools-extra/clang-doc/MDGenerator.cpp
===
--- clang-tools-extra/clang-doc/MDGenerator.cpp
+++ clang-tools-extra/clang-doc/MDGenerator.cpp
@@ -82,10 +82,14 @@
 OS << genEmphasis(I.Name) << " " << I.Text;
   } else if (I.Kind == "ParamCommandComment") {
 std::string Direction = I.Explicit ? (" " + I.Direction).str() : "";
-OS << genEmphasis(I.ParamName) << I.Text << Direction << "\n\n";
+OS << genEmphasis(I.ParamName) << I.Text << Direction;
+for (const auto &Child : I.Children)
+  writeDescription(*Child, OS);
   } else if (I.Kind == "TParamCommandComment") {
 std::string Direction = I.Explicit ? (" " + I.Direction).str() : "";
-OS << genEmphasis(I.ParamName) << I.Text << Direction << "\n\n";
+OS << genEmphasis(I.ParamName) << I.Text << Direction;
+for (const auto &Child : I.Children)
+  writeDescription(*Child, OS);
   } else if (I.Kind == "VerbatimBlockComment") {
 for (const auto &Child : I.Children)
   writeDescription(*Child, OS);


Index: clang-tools-extra/unittests/clang-doc/MDGeneratorTest.cpp
===
--- clang-tools-extra/unittests/clang-doc/MDGeneratorTest.cpp
+++ clang-tools-extra/unittests/clang-doc/MDGeneratorTest.cpp
@@ -347,9 +347,9 @@
 
  The description continues.
 
-**I** [out]
+**I** [out] is a parameter.
 
-**J**
+**J** is a parameter.
 
 **return**void
 
Index: clang-tools-extra/clang-doc/MDGenerator.cpp
===
--- clang-tools-extra/clang-doc/MDGenerator.cpp
+++ clang-tools-extra/clang-doc/MDGenerator.cpp
@@ -82,10 +82,14 @@
 OS << genEmphasis(I.Name) << " " << I.Text;
   } else if (I.Kind == "ParamCommandComment") {
 std::string Direction = I.Explicit ? (" " + I.Direction).str() : "";
-OS << genEmphasis(I.ParamName) << I.Text << Direction << "\n\n";
+OS << genEmphasis(I.ParamName) << I.Text << Direction;
+for (const auto &Child : I.Children)
+  writeDescription(*Child, OS);
   } else if (I.Kind == "TParamCommandComment") {
 std::string Direction = I.Explicit ? (" " + I.Direction).str() : "";
-OS << genEmphasis(I.ParamName) << I.Text << Direction << "\n\n";
+OS << genEmphasis(I.ParamName) << I.Text << Direction;
+for (const auto &Child : I.Children)
+  writeDescription(*Child, OS);
   } else if (I.Kind == "VerbatimBlockComment") {
 for (const auto &Child : I.Children)
   writeDescription(*Child, OS);
___
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

[PATCH] D156322: Outputs parameter comments using clang-doc and markdown generator

2023-07-27 Thread Arnaud Botella via Phabricator via cfe-commits 
BotellaA added a comment.

Thanks. 
You can use this name Arnaud Botella with this email 
arnaud.bote...@geode-solutions.com.


CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D156322/new/

https://reviews.llvm.org/D156322

___
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits