diff options
| author | Martin Probst <martin@probst.io> | 2017-03-13 09:39:23 +0000 |
|---|---|---|
| committer | Martin Probst <martin@probst.io> | 2017-03-13 09:39:23 +0000 |
| commit | b4cdb65e5fbf5e50999e2b8a6dedf57da4ae98e5 (patch) | |
| tree | fc52ed1325dfb1edf62a96340ad4011f7f0f0c50 | |
| parent | 22b8d2692453ab29c0c1d3b24e3994fc4dcc5426 (diff) | |
| download | bcm5719-llvm-b4cdb65e5fbf5e50999e2b8a6dedf57da4ae98e5.tar.gz bcm5719-llvm-b4cdb65e5fbf5e50999e2b8a6dedf57da4ae98e5.zip | |
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
llvm-svn: 297607
| -rw-r--r-- | clang/lib/Format/Format.cpp | 5 | ||||
| -rw-r--r-- | clang/unittests/Format/FormatTestJS.cpp | 7 |
2 files changed, 10 insertions, 2 deletions
diff --git a/clang/lib/Format/Format.cpp b/clang/lib/Format/Format.cpp index 07624620d01..9bb2a97ce5c 100644 --- a/clang/lib/Format/Format.cpp +++ b/clang/lib/Format/Format.cpp @@ -624,8 +624,9 @@ FormatStyle getGoogleStyle(FormatStyle::LanguageKind Language) { 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; diff --git a/clang/unittests/Format/FormatTestJS.cpp b/clang/unittests/Format/FormatTestJS.cpp index 828250602be..62d7ec86c91 100644 --- a/clang/unittests/Format/FormatTestJS.cpp +++ b/clang/unittests/Format/FormatTestJS.cpp @@ -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" |
