Exclude javadoc @link from linelength #2414
Conversation
|
Thanks for your interest in palantir/gradle-baseline, @proggeo! Before we can accept your pull request, you need to sign our contributor license agreement - just visit https://cla.palantir.com/ and follow the instructions. Once you sign, I'll automatically update this pull request. |
Generate changelog in
|
| @@ -49,7 +49,7 @@ | |||
| </module> | |||
| <module name="LineLength"> <!-- Java Style Guide: No line-wrapping --> | |||
| <property name="max" value="120"/> | |||
| <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/> | |||
| <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://|\* \{@link"/> | |||
There was a problem hiding this comment.
I think just the {@link piece is sufficient, no need to match * {@link, this way we match a href handling.
There was a problem hiding this comment.
imo we should still encourage shorter lines. i.e., something like
* My amazing function runs the eternal engine. See {@link com.superlongcorpname.thebestteamever.AmazingEternalEngine#runThisSuperDuperAmazingEngine}
should still be forced to look like
* My amazing function runs the eternal engine. See
* {@link com.superlongcorpname.thebestteamever.AmazingEternalEngine#runThisSuperDuperAmazingEngine}
There was a problem hiding this comment.
I get that, however consistency is more important with this sort of thing than optimality.
For example, how would this work in the context of a list in javadoc (or other nested structure used in high-quality documentation).
If we want to bike-shed on optimality, the following results in the smallest maximum line length, but isn't covered by either suppression (which is fine imo because it matches the behavior of a href!)
/**
* My amazing function runs the eternal engine. See {@link
* com.superlongcorpname.thebestteamever.AmazingEternalEngine#runThisSuperDuperAmazingEngine
* }
*/
|
Released 4.180.0 |
###### _excavator_ is a bot for automating changes across repositories. Changes produced by the roomba/latest-baseline-oss check. # Release Notes ## 4.180.0 | Type | Description | Link | | ---- | ----------- | ---- | | Improvement | exempt @link javadoc comment from LineLength check | palantir/gradle-baseline#2414 | To enable or disable this check, please contact the maintainers of Excavator.
@linkin javadoc should not break into multiple linesBefore this PR
Using
@linkwith a long reference would trigger LineLength violation.After this PR
@linkjavadoc comment lines are exempted from LineLength checkPossible downsides?