Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix all warnings reported by ./gradlew javadoc #3330

Merged
merged 6 commits into from Oct 30, 2023
Merged

Fix all warnings reported by ./gradlew javadoc #3330

merged 6 commits into from Oct 30, 2023

Conversation

unp1
Copy link
Member

@unp1 unp1 commented Oct 30, 2023 •
edited

see title

@unp1 unp1 self-assigned this Oct 30, 2023
@unp1 unp1 added Documentation Improvements or additions to documentation 🛠 Maintenance Code quality and related things w/o functional changes labels Oct 30, 2023
@unp1 unp1 enabled auto-merge October 30, 2023 08:18
@unp1 unp1 requested a review from Drodt October 30, 2023 08:18
@codecov
Copy link

codecov bot commented Oct 30, 2023 •
edited

Codecov Report

Merging #3330 (e3880ec) into main (b3b9778) will decrease coverage by 0.01%.
The diff coverage is 0.00%.

@@             Coverage Diff              @@
##               main    #3330      +/-   ##
============================================
- Coverage     37.83%   37.83%   -0.01%     
  Complexity    16882    16882              
============================================
  Files          2052     2052              
  Lines        125455   125455              
  Branches      21215    21215              
============================================
- Hits          47471    47470       -1     
  Misses        72133    72133              
- Partials       5851     5852       +1
Files Coverage Δ
...va/de/uka/ilkd/key/java/ContextStatementBlock.java 75.86% <ø> (ø)
...de/uka/ilkd/key/java/CreateArrayMethodBuilder.java 94.89% <ø> (ø)
...e/src/main/java/de/uka/ilkd/key/java/JavaInfo.java 64.12% <ø> (ø)
...ava/de/uka/ilkd/key/java/Recoder2KeYConverter.java 72.32% <ø> (ø)
...lkd/key/java/declaration/ParameterDeclaration.java 58.69% <ø> (ø)
...n/java/de/uka/ilkd/key/java/recoderext/Ccatch.java 29.92% <ø> (ø)
...coderext/CcatchBreakLabelParameterDeclaration.java 24.13% <ø> (ø)
...erext/CcatchContinueLabelParameterDeclaration.java 24.13% <ø> (ø)
...ecoderext/CcatchReturnValParameterDeclaration.java 25.53% <ø> (ø)
.../java/recoderext/ConstructorNormalformBuilder.java 78.94% <ø> (ø)
... and 54 more

... and 1 file with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

FliegendeWurst
FliegendeWurst reviewed Oct 30, 2023
View reviewed changes
...olic_execution/src/main/java/de/uka/ilkd/key/symbolic_execution/SymbolicLayoutExtractor.java Outdated Show resolved Hide resolved
...olic_execution/src/main/java/de/uka/ilkd/key/symbolic_execution/SymbolicLayoutExtractor.java Outdated Show resolved Hide resolved
...lic_execution/src/main/java/de/uka/ilkd/key/symbolic_execution/po/ProgramMethodSubsetPO.java Outdated Show resolved Hide resolved
key.core/src/main/java/de/uka/ilkd/key/logic/op/SubstOp.java Outdated Show resolved Hide resolved
key.core/src/main/java/de/uka/ilkd/key/speclang/WellDefinednessCheck.java Outdated Show resolved Hide resolved
key.util/src/main/java/org/key_project/util/java/XMLUtil.java Outdated Show resolved Hide resolved
recoder/src/main/java/recoder/java/expression/operator/New.java Outdated Show resolved Hide resolved
@unp1 @FliegendeWurst @Drodt
Apply suggestions from code review
c9b85f6 
Suggestions from reviewers

Co-authored-by: Arne Keller <arne.keller@posteo.de>
Co-authored-by: Daniel Drodt <132357467+Drodt@users.noreply.github.com>
@unp1 unp1 disabled auto-merge October 30, 2023 11:25
@unp1 unp1 enabled auto-merge October 30, 2023 11:25
@unp1 unp1 force-pushed the fixAllGradleJavaDocWarnings branch from cdf6daf to 3ef9ff7 Compare October 30, 2023 11:27
@unp1
Copy link
Member Author

unp1 commented Oct 30, 2023 •
edited

There is a problem with spotlessApply which will turn some occurrences of @code to &#64; (but not all and also not all in a pre block). Solved this by switching spotless off for these comments.

@unp1 unp1 force-pushed the fixAllGradleJavaDocWarnings branch 2 times, most recently from 93d85b4 to 6d8c70b Compare October 30, 2023 12:46
@unp1
More fixes and polishing (spotlessApply turns some @ to their encodin…
552f06a 
…g number; for those comments it is switched off)
@unp1 unp1 force-pushed the fixAllGradleJavaDocWarnings branch from 6d8c70b to 552f06a Compare October 30, 2023 13:21
@unp1 unp1 added this pull request to the merge queue Oct 30, 2023
Merged via the queue into main with commit 6a06061 Oct 30, 2023
12 of 14 checks passed
@unp1 unp1 deleted the fixAllGradleJavaDocWarnings branch October 30, 2023 17:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@FliegendeWurst FliegendeWurst FliegendeWurst left review comments

@Drodt Drodt Drodt approved these changes

Assignees

@unp1 unp1

Labels
Documentation Improvements or additions to documentation 🛠 Maintenance Code quality and related things w/o functional changes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@unp1 @FliegendeWurst @Drodt