Author: gribozavr
Date: Tue Jul 31 19:48:00 2012
New Revision: 161096
URL: http://llvm.org/viewvc/llvm-project?rev=161096&view=rev
Log:
Comment to HTML conversion: skip \tparam commands with whitespace paragraphs
Modified:
cfe/trunk/test/Index/annotate-comments.cpp
cfe/trunk/tools/libclang/CXComment.cpp
Modified: cfe/trunk/test/Index/annotate-comments.cpp
URL:
http://llvm.org/viewvc/llvm-project/cfe/trunk/test/Index/annotate-comments.cpp?rev=161096&r1=161095&r2=161096&view=diff
==============================================================================
--- cfe/trunk/test/Index/annotate-comments.cpp (original)
+++ cfe/trunk/test/Index/annotate-comments.cpp Tue Jul 31 19:48:00 2012
@@ -295,24 +295,29 @@
template<typename T>
void comment_to_html_conversion_17(T aaa);
+/// \tparam T
+/// \param aaa Blah blah
+template<typename T>
+void comment_to_html_conversion_18(T aaa);
+
/// \tparam T2 Bbb
/// \tparam T1 Aaa
template<typename T1, typename T2>
-void comment_to_html_conversion_18(T1 aaa, T2 bbb);
+void comment_to_html_conversion_19(T1 aaa, T2 bbb);
/// \tparam T2 Bbb
/// \tparam U Zzz
/// \tparam V Ccc
/// \tparam T1 Aaa
template<typename T1, typename T2, int V>
-void comment_to_html_conversion_19(T1 aaa, T2 bbb);
+void comment_to_html_conversion_20(T1 aaa, T2 bbb);
/// \tparam TTT Ddd
/// \tparam C Ccc
/// \tparam T Aaa
/// \tparam TT Bbb
template<template<template<typename T> class TT, class C> class TTT>
-void comment_to_html_conversion_20();
+void comment_to_html_conversion_21();
/// \brief Aaa.
///
@@ -321,37 +326,37 @@
/// \param x2 Ddd.
/// \param x1 Ccc.
/// \returns Eee.
-void comment_to_html_conversion_21(int x1, int x2);
+void comment_to_html_conversion_22(int x1, int x2);
/// <br><a href="http://example.com/";>Aaa</a>
-void comment_to_html_conversion_22();
+void comment_to_html_conversion_23();
/// \verbatim
/// <a href="http://example.com/";>Aaa</a>
/// <a href='http://example.com/'>Aaa</a>
/// \endverbatim
-void comment_to_html_conversion_23();
+void comment_to_html_conversion_24();
/// \b Aaa
-void comment_to_html_conversion_24();
+void comment_to_html_conversion_25();
/// \c Aaa \p Bbb
-void comment_to_html_conversion_25();
+void comment_to_html_conversion_26();
/// \a Aaa \e Bbb \em Ccc
-void comment_to_html_conversion_26();
+void comment_to_html_conversion_27();
/// \a 1<2 \e 3<4 \em 5<6 \param 7<8 aaa \tparam 9<10 bbb
-void comment_to_html_conversion_27();
+void comment_to_html_conversion_28();
/// \\ \@ \& \$ \# \< \> \% \" \. \::
-void comment_to_html_conversion_28();
+void comment_to_html_conversion_29();
/// & < > "
-void comment_to_html_conversion_29();
+void comment_to_html_conversion_30();
/// <em>0<i</em>
-void comment_to_html_conversion_30();
+void comment_to_html_conversion_31();
#endif
@@ -593,7 +598,18 @@
// CHECK-NEXT: (CXComment_ParamCommand in implicitly ParamName=[aaa]
ParamIndex=0
// CHECK-NEXT: (CXComment_Paragraph
// CHECK-NEXT: (CXComment_Text Text=[ Blah blah]))))]
-// CHECK: annotate-comments.cpp:301:6:
FunctionTemplate=comment_to_html_conversion_18:{{.*}}
FullCommentAsHTML=[<dl><dt class="taram-name-index-0">T1</dt><dd
class="tparam-descr-index-0"> Aaa</dd><dt class="taram-name-index-1">T2</dt><dd
class="tparam-descr-index-1"> Bbb </dd></dl>]
+// CHECK: annotate-comments.cpp:301:6:
FunctionTemplate=comment_to_html_conversion_18:{{.*}}
FullCommentAsHTML=[<dl><dt class="param-name-index-0">aaa</dt><dd
class="param-descr-index-0"> Blah blah</dd></dl>]
+// CHECK-NEXT: CommentAST=[
+// CHECK-NEXT: (CXComment_FullComment
+// CHECK-NEXT: (CXComment_Paragraph IsWhitespace
+// CHECK-NEXT: (CXComment_Text Text=[ ] IsWhitespace))
+// CHECK-NEXT: (CXComment_TParamCommand ParamName=[T] ParamPosition={0}
+// CHECK-NEXT: (CXComment_Paragraph IsWhitespace
+// CHECK-NEXT: (CXComment_Text Text=[ ] IsWhitespace)))
+// CHECK-NEXT: (CXComment_ParamCommand in implicitly ParamName=[aaa]
ParamIndex=0
+// CHECK-NEXT: (CXComment_Paragraph
+// CHECK-NEXT: (CXComment_Text Text=[ Blah blah]))))]
+// CHECK: annotate-comments.cpp:306:6:
FunctionTemplate=comment_to_html_conversion_19:{{.*}}
FullCommentAsHTML=[<dl><dt class="taram-name-index-0">T1</dt><dd
class="tparam-descr-index-0"> Aaa</dd><dt class="taram-name-index-1">T2</dt><dd
class="tparam-descr-index-1"> Bbb </dd></dl>]
// CHECK-NEXT: CommentAST=[
// CHECK-NEXT: (CXComment_FullComment
// CHECK-NEXT: (CXComment_Paragraph IsWhitespace
@@ -605,7 +621,7 @@
// CHECK-NEXT: (CXComment_TParamCommand ParamName=[T1] ParamPosition={0}
// CHECK-NEXT: (CXComment_Paragraph
// CHECK-NEXT: (CXComment_Text Text=[ Aaa]))))]
-// CHECK: annotate-comments.cpp:308:6:
FunctionTemplate=comment_to_html_conversion_19:{{.*}}
FullCommentAsHTML=[<dl><dt class="taram-name-index-0">T1</dt><dd
class="tparam-descr-index-0"> Aaa</dd><dt class="taram-name-index-1">T2</dt><dd
class="tparam-descr-index-1"> Bbb </dd><dt class="taram-name-index-2">V</dt><dd
class="tparam-descr-index-2"> Ccc </dd><dt
class="tparam-name-index-invalid">U</dt><dd class="tparam-descr-index-invalid">
Zzz </dd></dl>]
+// CHECK: annotate-comments.cpp:313:6:
FunctionTemplate=comment_to_html_conversion_20:{{.*}}
FullCommentAsHTML=[<dl><dt class="taram-name-index-0">T1</dt><dd
class="tparam-descr-index-0"> Aaa</dd><dt class="taram-name-index-1">T2</dt><dd
class="tparam-descr-index-1"> Bbb </dd><dt class="taram-name-index-2">V</dt><dd
class="tparam-descr-index-2"> Ccc </dd><dt
class="tparam-name-index-invalid">U</dt><dd class="tparam-descr-index-invalid">
Zzz </dd></dl>]
// CHECK-NEXT: CommentAST=[
// CHECK-NEXT: (CXComment_FullComment
// CHECK-NEXT: (CXComment_Paragraph IsWhitespace
@@ -625,7 +641,7 @@
// CHECK-NEXT: (CXComment_TParamCommand ParamName=[T1] ParamPosition={0}
// CHECK-NEXT: (CXComment_Paragraph
// CHECK-NEXT: (CXComment_Text Text=[ Aaa]))))]
-// CHECK: annotate-comments.cpp:315:6:
FunctionTemplate=comment_to_html_conversion_20:{{.*}}
FullCommentAsHTML=[<dl><dt class="taram-name-index-0">TTT</dt><dd
class="tparam-descr-index-0"> Ddd </dd><dt
class="taram-name-index-other">C</dt><dd class="tparam-descr-index-other"> Ccc
</dd><dt class="taram-name-index-other">T</dt><dd
class="tparam-descr-index-other"> Aaa </dd><dt
class="taram-name-index-other">TT</dt><dd class="tparam-descr-index-other">
Bbb</dd></dl>]
+// CHECK: annotate-comments.cpp:320:6:
FunctionTemplate=comment_to_html_conversion_21:{{.*}}
FullCommentAsHTML=[<dl><dt class="taram-name-index-0">TTT</dt><dd
class="tparam-descr-index-0"> Ddd </dd><dt
class="taram-name-index-other">C</dt><dd class="tparam-descr-index-other"> Ccc
</dd><dt class="taram-name-index-other">T</dt><dd
class="tparam-descr-index-other"> Aaa </dd><dt
class="taram-name-index-other">TT</dt><dd class="tparam-descr-index-other">
Bbb</dd></dl>]
// CHECK-NEXT: CommentAST=[
// CHECK-NEXT: (CXComment_FullComment
// CHECK-NEXT: (CXComment_Paragraph IsWhitespace
@@ -645,7 +661,7 @@
// CHECK-NEXT: (CXComment_TParamCommand ParamName=[TT] ParamPosition={0,
0}
// CHECK-NEXT: (CXComment_Paragraph
// CHECK-NEXT: (CXComment_Text Text=[ Bbb]))))]
-// CHECK: annotate-comments.cpp:324:6:
FunctionDecl=comment_to_html_conversion_21:{{.*}} FullCommentAsHTML=[<p
class="para-brief"> Aaa.</p><p> Bbb.</p><dl><dt
class="param-name-index-0">x1</dt><dd class="param-descr-index-0"> Ccc.
</dd><dt class="param-name-index-1">x2</dt><dd class="param-descr-index-1">
Ddd. </dd></dl><p class="para-returns"><span
class="word-returns">Returns</span> Eee.</p>]
+// CHECK: annotate-comments.cpp:329:6:
FunctionDecl=comment_to_html_conversion_22:{{.*}} FullCommentAsHTML=[<p
class="para-brief"> Aaa.</p><p> Bbb.</p><dl><dt
class="param-name-index-0">x1</dt><dd class="param-descr-index-0"> Ccc.
</dd><dt class="param-name-index-1">x2</dt><dd class="param-descr-index-1">
Ddd. </dd></dl><p class="para-returns"><span
class="word-returns">Returns</span> Eee.</p>]
// CHECK-NEXT: CommentAST=[
// CHECK-NEXT: (CXComment_FullComment
// CHECK-NEXT: (CXComment_Paragraph IsWhitespace
@@ -668,7 +684,7 @@
// CHECK-NEXT: (CXComment_BlockCommand CommandName=[returns]
// CHECK-NEXT: (CXComment_Paragraph
// CHECK-NEXT: (CXComment_Text Text=[ Eee.]))))]
-// CHECK: annotate-comments.cpp:327:6:
FunctionDecl=comment_to_html_conversion_22:{{.*}} FullCommentAsHTML=[<p
class="para-brief"> <br><a href="http://example.com/";>Aaa</a></p>]
+// CHECK: annotate-comments.cpp:332:6:
FunctionDecl=comment_to_html_conversion_23:{{.*}} FullCommentAsHTML=[<p
class="para-brief"> <br><a href="http://example.com/";>Aaa</a></p>]
// CHECK-NEXT: CommentAST=[
// CHECK-NEXT: (CXComment_FullComment
// CHECK-NEXT: (CXComment_Paragraph
@@ -677,7 +693,7 @@
// CHECK-NEXT: (CXComment_HTMLStartTag Name=[a] Attrs:
href=http://example.com/)
// CHECK-NEXT: (CXComment_Text Text=[Aaa])
// CHECK-NEXT: (CXComment_HTMLEndTag Name=[a])))]
-// CHECK: annotate-comments.cpp:333:6:
FunctionDecl=comment_to_html_conversion_23:{{.*}} FullCommentAsHTML=[<pre>
<a href="http://example.com/">Aaa</a>\n
<a href='http://example.com/'>Aaa</a></pre>]
+// CHECK: annotate-comments.cpp:338:6:
FunctionDecl=comment_to_html_conversion_24:{{.*}} FullCommentAsHTML=[<pre>
<a href="http://example.com/">Aaa</a>\n
<a href='http://example.com/'>Aaa</a></pre>]
// CHECK-NEXT: CommentAST=[
// CHECK-NEXT: (CXComment_FullComment
// CHECK-NEXT: (CXComment_Paragraph IsWhitespace
@@ -685,13 +701,13 @@
// CHECK-NEXT: (CXComment_VerbatimBlockCommand CommandName=[verbatim]
// CHECK-NEXT: (CXComment_VerbatimBlockLine Text=[ <a
href="http://example.com/";>Aaa</a>])
// CHECK-NEXT: (CXComment_VerbatimBlockLine Text=[ <a
href='http://example.com/'>Aaa</a>])))]
-// CHECK: annotate-comments.cpp:336:6:
FunctionDecl=comment_to_html_conversion_24:{{.*}} FullCommentAsHTML=[<p
class="para-brief"> <b>Aaa</b></p>]
+// CHECK: annotate-comments.cpp:341:6:
FunctionDecl=comment_to_html_conversion_25:{{.*}} FullCommentAsHTML=[<p
class="para-brief"> <b>Aaa</b></p>]
// CHECK-NEXT: CommentAST=[
// CHECK-NEXT: (CXComment_FullComment
// CHECK-NEXT: (CXComment_Paragraph
// CHECK-NEXT: (CXComment_Text Text=[ ] IsWhitespace)
// CHECK-NEXT: (CXComment_InlineCommand CommandName=[b] RenderBold
Arg[0]=Aaa)))]
-// CHECK: annotate-comments.cpp:339:6:
FunctionDecl=comment_to_html_conversion_25:{{.*}} FullCommentAsHTML=[<p
class="para-brief"> <tt>Aaa</tt> <tt>Bbb</tt></p>]
+// CHECK: annotate-comments.cpp:344:6:
FunctionDecl=comment_to_html_conversion_26:{{.*}} FullCommentAsHTML=[<p
class="para-brief"> <tt>Aaa</tt> <tt>Bbb</tt></p>]
// CHECK-NEXT: CommentAST=[
// CHECK-NEXT: (CXComment_FullComment
// CHECK-NEXT: (CXComment_Paragraph
@@ -699,7 +715,7 @@
// CHECK-NEXT: (CXComment_InlineCommand CommandName=[c]
RenderMonospaced Arg[0]=Aaa)
// CHECK-NEXT: (CXComment_Text Text=[ ] IsWhitespace)
// CHECK-NEXT: (CXComment_InlineCommand CommandName=[p]
RenderMonospaced Arg[0]=Bbb)))]
-// CHECK: annotate-comments.cpp:342:6:
FunctionDecl=comment_to_html_conversion_26:{{.*}} FullCommentAsHTML=[<p
class="para-brief"> <em>Aaa</em> <em>Bbb</em> <em>Ccc</em></p>]
+// CHECK: annotate-comments.cpp:347:6:
FunctionDecl=comment_to_html_conversion_27:{{.*}} FullCommentAsHTML=[<p
class="para-brief"> <em>Aaa</em> <em>Bbb</em> <em>Ccc</em></p>]
// CHECK-NEXT: CommentAST=[
// CHECK-NEXT: (CXComment_FullComment
// CHECK-NEXT: (CXComment_Paragraph
@@ -709,7 +725,7 @@
// CHECK-NEXT: (CXComment_InlineCommand CommandName=[e]
RenderEmphasized Arg[0]=Bbb)
// CHECK-NEXT: (CXComment_Text Text=[ ] IsWhitespace)
// CHECK-NEXT: (CXComment_InlineCommand CommandName=[em]
RenderEmphasized Arg[0]=Ccc)))]
-// CHECK: annotate-comments.cpp:345:6:
FunctionDecl=comment_to_html_conversion_27:{{.*}} FullCommentAsHTML=[<p
class="para-brief"> <em>1<2</em> <em>3<4</em> <em>5<6</em> </p><dl><dt
class="tparam-name-index-invalid">9<10</dt><dd
class="tparam-descr-index-invalid"> bbb</dd></dl><dl><dt
class="param-name-index-invalid">7<8</dt><dd
class="param-descr-index-invalid"> aaa </dd></dl>]
+// CHECK: annotate-comments.cpp:350:6:
FunctionDecl=comment_to_html_conversion_28:{{.*}} FullCommentAsHTML=[<p
class="para-brief"> <em>1<2</em> <em>3<4</em> <em>5<6</em> </p><dl><dt
class="tparam-name-index-invalid">9<10</dt><dd
class="tparam-descr-index-invalid"> bbb</dd></dl><dl><dt
class="param-name-index-invalid">7<8</dt><dd
class="param-descr-index-invalid"> aaa </dd></dl>]
// CHECK-NEXT: CommentAST=[
// CHECK-NEXT: (CXComment_FullComment
// CHECK-NEXT: (CXComment_Paragraph
@@ -726,7 +742,7 @@
// CHECK-NEXT: (CXComment_TParamCommand ParamName=[9<10]
ParamPosition=Invalid
// CHECK-NEXT: (CXComment_Paragraph
// CHECK-NEXT: (CXComment_Text Text=[ bbb]))))]
-// CHECK: annotate-comments.cpp:348:6:
FunctionDecl=comment_to_html_conversion_28:{{.*}} FullCommentAsHTML=[<p
class="para-brief"> \ @ & $ # < > % " . ::</p>]
+// CHECK: annotate-comments.cpp:353:6:
FunctionDecl=comment_to_html_conversion_29:{{.*}} FullCommentAsHTML=[<p
class="para-brief"> \ @ & $ # < > % " . ::</p>]
// CHECK-NEXT: CommentAST=[
// CHECK-NEXT: (CXComment_FullComment
// CHECK-NEXT: (CXComment_Paragraph
@@ -752,7 +768,7 @@
// CHECK-NEXT: (CXComment_Text Text=[.])
// CHECK-NEXT: (CXComment_Text Text=[ ] IsWhitespace)
// CHECK-NEXT: (CXComment_Text Text=[::])))]
-// CHECK: annotate-comments.cpp:351:6:
FunctionDecl=comment_to_html_conversion_29:{{.*}} FullCommentAsHTML=[<p
class="para-brief"> & < > "</p>]
+// CHECK: annotate-comments.cpp:356:6:
FunctionDecl=comment_to_html_conversion_30:{{.*}} FullCommentAsHTML=[<p
class="para-brief"> & < > "</p>]
// CHECK-NEXT: CommentAST=[
// CHECK-NEXT: (CXComment_FullComment
// CHECK-NEXT: (CXComment_Paragraph
@@ -764,7 +780,7 @@
// CHECK-NEXT: (CXComment_Text Text=[>])
// CHECK-NEXT: (CXComment_Text Text=[ ] IsWhitespace)
// CHECK-NEXT: (CXComment_Text Text=["])))]
-// CHECK: annotate-comments.cpp:354:6:
FunctionDecl=comment_to_html_conversion_30:{{.*}} FullCommentAsHTML=[<p
class="para-brief"> <em>0<i</em></p>]
+// CHECK: annotate-comments.cpp:359:6:
FunctionDecl=comment_to_html_conversion_31:{{.*}} FullCommentAsHTML=[<p
class="para-brief"> <em>0<i</em></p>]
// CHECK-NEXT: CommentAST=[
// CHECK-NEXT: (CXComment_FullComment
// CHECK-NEXT: (CXComment_Paragraph
Modified: cfe/trunk/tools/libclang/CXComment.cpp
URL:
http://llvm.org/viewvc/llvm-project/cfe/trunk/tools/libclang/CXComment.cpp?rev=161096&r1=161095&r2=161096&view=diff
==============================================================================
--- cfe/trunk/tools/libclang/CXComment.cpp (original)
+++ cfe/trunk/tools/libclang/CXComment.cpp Tue Jul 31 19:48:00 2012
@@ -676,6 +676,9 @@
if (!TPCC->hasParamName())
break;
+ if (!TPCC->hasNonWhitespaceParagraph())
+ break;
+
TParams.push_back(TPCC);
break;
}
_______________________________________________
cfe-commits mailing list
[email protected]
http://lists.cs.uiuc.edu/mailman/listinfo/cfe-commits
