Author: mprobst
Date: Mon Mar 13 04:39:23 2017
New Revision: 297607
URL: http://llvm.org/viewvc/llvm-project?rev=297607&view=rev
Log:
clang-format: [JS] do not wrap @see tags.
Summary:
@see is special among JSDoc tags in that it is commonly followed by URLs. The
JSDoc spec suggests that users should wrap URLs in an additional {@link url...}
tag (@see http://usejsdoc.org/tags-see.html), but this is very commonly
violated, with @see being followed by a "naked" URL.
This change special cases all JSDoc lines that contain an @see not to be
wrapped to account for that.
Reviewers: djasper
Subscribers: klimek, cfe-commits
Differential Revision: https://reviews.llvm.org/D30883
Modified:
cfe/trunk/lib/Format/Format.cpp
cfe/trunk/unittests/Format/FormatTestJS.cpp
Modified: cfe/trunk/lib/Format/Format.cpp
URL:
http://llvm.org/viewvc/llvm-project/cfe/trunk/lib/Format/Format.cpp?rev=297607&r1=297606&r2=297607&view=diff
==============================================================================
--- cfe/trunk/lib/Format/Format.cpp (original)
+++ cfe/trunk/lib/Format/Format.cpp Mon Mar 13 04:39:23 2017
@@ -624,8 +624,9 @@ FormatStyle getGoogleStyle(FormatStyle::
GoogleStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Empty;
GoogleStyle.AlwaysBreakBeforeMultilineStrings = false;
GoogleStyle.BreakBeforeTernaryOperators = false;
- // taze:, and @tag followed by { for a lot of JSDoc tags.
- GoogleStyle.CommentPragmas = "(taze:|(@[A-Za-z_0-9-]+[ \\t]*{))";
+ // taze:, @tag followed by { for a lot of JSDoc tags, and @see, which is
+ // commonly followed by overlong URLs.
+ GoogleStyle.CommentPragmas = "(taze:|(@[A-Za-z_0-9-]+[ \\t]*{)|@see)";
GoogleStyle.MaxEmptyLinesToKeep = 3;
GoogleStyle.NamespaceIndentation = FormatStyle::NI_All;
GoogleStyle.SpacesInContainerLiterals = false;
Modified: cfe/trunk/unittests/Format/FormatTestJS.cpp
URL:
http://llvm.org/viewvc/llvm-project/cfe/trunk/unittests/Format/FormatTestJS.cpp?rev=297607&r1=297606&r2=297607&view=diff
==============================================================================
--- cfe/trunk/unittests/Format/FormatTestJS.cpp (original)
+++ cfe/trunk/unittests/Format/FormatTestJS.cpp Mon Mar 13 04:39:23 2017
@@ -1611,6 +1611,13 @@ TEST_F(FormatTestJS, JSDocAnnotations) {
" * @param {this.is.a.long.path.to.a.Type}\n"
" */",
getGoogleJSStyleWithColumns(20));
+ verifyFormat("/**\n"
+ " * @see http://very/very/long/url/is/long\n";
+ " */",
+ "/**\n"
+ " * @see http://very/very/long/url/is/long\n";
+ " */",
+ getGoogleJSStyleWithColumns(20));
verifyFormat(
"/**\n"
" * @param This is a\n"
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
