Improve API documentation for PathSensitivity and PathSensitive #6983
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This relocates some of the API documentation for PathSensitivity and PathSensitive which today can only be found in the Gradle Guides into the java docs for these types. Signed-off-by: Jonathan Leitschuh <Jonathan.Leitschuh@plexxi.com>
|
@wolfs Anything more you need from me? |
wolfs
requested changes
Oct 10, 2018
| @@ -28,6 +28,8 @@ | |||
| * <p>This annotation should be attached to the getter method in Java or the property in Groovy. | |||
| * Annotations on setters or just the field in Java are ignored.</p> | |||
| * | |||
| * <p>If a {@link CacheableTask} declares a file property without this annotation, the default is {@link PathSensitivity#ABSOLUTE}.</p> | |||
There was a problem hiding this comment.
The default is ABSOLUTE for all tasks, not only for CacheableTasks.
| @@ -26,6 +26,8 @@ | |||
| public enum PathSensitivity { | |||
| /** | |||
| * Consider the full path of files and directories. | |||
| * | |||
| * <p><b>This will prevent the task's outputs from being shared across different users via a shared cache.</b></p> | |||
There was a problem hiding this comment.
across different workspaces via the build cache would be better I think.
| @@ -39,6 +39,10 @@ public void visitPropertyValue(PropertyValue propertyValue, PropertyVisitor visi | |||
| PathSensitive pathSensitive = propertyValue.getAnnotation(PathSensitive.class); | |||
| final PathSensitivity pathSensitivity; | |||
| if (pathSensitive == null) { | |||
| /* | |||
There was a problem hiding this comment.
Let's not use multi-line comments within code. Please use //.
Signed-off-by: Jonathan Leitschuh <Jonathan.Leitschuh@plexxi.com>
wolfs
approved these changes
Oct 10, 2018
eskatos
pushed a commit
that referenced
this pull request
Oct 11, 2018
This adds some of the API documentation for PathSensitivity and PathSensitive which today can only be found in the Gradle Guides into the java docs for these types.
wolfs
pushed a commit
that referenced
this pull request
Oct 11, 2018
This adds some of the API documentation for PathSensitivity and PathSensitive which today can only be found in the Gradle Guides into the java docs for these types.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This relocates some of the API documentation for PathSensitivity and PathSensitive
which today can only be found in the Gradle Guides into the java docs for these
types.
Context
I dug this information out because of a question someone had in this issue here: detekt/detekt#1178 (comment)
I found the information hard to find and required digging through the various guides to find.
I figured it should also be part of the javadocs.
This documentation comes partially from this comment on the release notes for 4.0.1:
Other parts of the documentation came from this part of the guide: https://guides.gradle.org/using-build-cache/#relocatability
Contributor Checklist
<subproject>/src/integTest) to verify changes from a user perspective<subproject>/src/test) to verify logic./gradlew <changed-subproject>:checkGradle Core Team Checklist