diff options
| author | Duarte Meneses <duarte.meneses@sonarsource.com> | 2016-10-28 10:12:30 +0200 |
|---|---|---|
| committer | Duarte Meneses <duarte.meneses@sonarsource.com> | 2016-10-28 10:12:33 +0200 |
| commit | 89e4b5d843df24e8ae0fec5faa0ad4a816160a53 (patch) | |
| tree | 536aabd69c9270c312d5a0b4c890c045f0cc6959 /sonar-plugin-api | |
| parent | 1b93884d1526403aa591ee2c197930e1bc28fee1 (diff) | |
| download | sonarqube-89e4b5d843df24e8ae0fec5faa0ad4a816160a53.tar.gz sonarqube-89e4b5d843df24e8ae0fec5faa0ad4a816160a53.zip | |
Improve InputFile javadoc
Diffstat (limited to 'sonar-plugin-api')
| -rw-r--r-- | sonar-plugin-api/src/main/java/org/sonar/api/batch/fs/InputFile.java | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/batch/fs/InputFile.java b/sonar-plugin-api/src/main/java/org/sonar/api/batch/fs/InputFile.java index 450dd704416..923575d7fee 100644 --- a/sonar-plugin-api/src/main/java/org/sonar/api/batch/fs/InputFile.java +++ b/sonar-plugin-api/src/main/java/org/sonar/api/batch/fs/InputFile.java @@ -79,13 +79,18 @@ public interface InputFile extends InputPath { String absolutePath(); /** - * The underlying absolute {@link java.io.File} + * The underlying absolute {@link java.io.File}. It should not be used to read the file in the filesystem. + * @see #contents() + * @see #inputStream() */ @Override File file(); /** - * The underlying absolute {@link Path} + * The underlying absolute {@link Path}. + * It should not be used to read the file in the filesystem. + * @see #contents() + * @see #inputStream() * @since 5.1 */ @Override |