aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com
diff options
context:
space:
mode:
authorGravatar Benjamin Peterson <bp@benjamin.pe>2018-02-22 01:43:41 -0800
committerGravatar Copybara-Service <copybara-piper@google.com>2018-02-22 01:45:39 -0800
commit93a6730d30f1e0d59d7d01788ea47c2171d1085a (patch)
treea927547d3105f9a1e219733abbd654c20df835f1 /src/main/java/com
parent0cf94e91ea8d3fbab9c12f92e19e8fa9ad9e8a65 (diff)
Update javadoc for some headers and include dirs methods.
Methods that return NestedSet shouldn't claim they may return duplicates or their return value will have any sort of meaningful order. Change-Id: I98f92ec6ddbf4d35fea47b12bcd072bb1b0f1e43 PiperOrigin-RevId: 186585490
Diffstat (limited to 'src/main/java/com')
-rw-r--r--src/main/java/com/google/devtools/build/lib/rules/cpp/CcCompilationInfo.java28
-rw-r--r--src/main/java/com/google/devtools/build/lib/rules/cpp/CppCompileAction.java15
2 files changed, 11 insertions, 32 deletions
diff --git a/src/main/java/com/google/devtools/build/lib/rules/cpp/CcCompilationInfo.java b/src/main/java/com/google/devtools/build/lib/rules/cpp/CcCompilationInfo.java
index 135865f271..42cf3f3e16 100644
--- a/src/main/java/com/google/devtools/build/lib/rules/cpp/CcCompilationInfo.java
+++ b/src/main/java/com/google/devtools/build/lib/rules/cpp/CcCompilationInfo.java
@@ -174,40 +174,24 @@ public final class CcCompilationInfo extends NativeInfo {
}
/**
- * Returns the immutable set of declared include directories, relative to a
- * "-I" or "-iquote" directory" (possibly empty but never null). The returned
- * collection may contain duplicate elements.
- *
- * <p>Note: The iteration order of this list is preserved as ide_build_info
- * writes these directories and sources out and the ordering will help when
- * used by consumers.
+ * Returns the immutable set of declared include directories, relative to a "-I" or "-iquote"
+ * directory" (possibly empty but never null).
*/
public NestedSet<PathFragment> getDeclaredIncludeDirs() {
return declaredIncludeDirs;
}
/**
- * Returns the immutable set of include directories, relative to a "-I" or
- * "-iquote" directory", from which inclusion will produce a warning (possibly
- * empty but never null). The returned collection may contain duplicate
- * elements.
- *
- * <p>Note: The iteration order of this list is preserved as ide_build_info
- * writes these directories and sources out and the ordering will help when
- * used by consumers.
+ * Returns the immutable set of include directories, relative to a "-I" or "-iquote" directory",
+ * from which inclusion will produce a warning (possibly empty but never null).
*/
public NestedSet<PathFragment> getDeclaredIncludeWarnDirs() {
return declaredIncludeWarnDirs;
}
/**
- * Returns the immutable set of headers that have been declared in the
- * {@code src} or {@code headers attribute} (possibly empty but never null).
- * The returned collection may contain duplicate elements.
- *
- * <p>Note: The iteration order of this list is preserved as ide_build_info
- * writes these directories and sources out and the ordering will help when
- * used by consumers.
+ * Returns the immutable set of headers that have been declared in the {@code srcs} or {@code
+ * hdrs} attribute (possibly empty but never null).
*/
public NestedSet<Artifact> getDeclaredIncludeSrcs() {
return declaredIncludeSrcs;
diff --git a/src/main/java/com/google/devtools/build/lib/rules/cpp/CppCompileAction.java b/src/main/java/com/google/devtools/build/lib/rules/cpp/CppCompileAction.java
index 98209e62d7..406bb8e8d1 100644
--- a/src/main/java/com/google/devtools/build/lib/rules/cpp/CppCompileAction.java
+++ b/src/main/java/com/google/devtools/build/lib/rules/cpp/CppCompileAction.java
@@ -1076,27 +1076,22 @@ public class CppCompileAction extends AbstractAction
}
/**
- * Return the directories in which to look for headers (pertains to headers
- * not specifically listed in {@code declaredIncludeSrcs}). The return value
- * may contain duplicate elements.
+ * Return the directories in which to look for headers (pertains to headers not specifically
+ * listed in {@code declaredIncludeSrcs}).
*/
public NestedSet<PathFragment> getDeclaredIncludeDirs() {
return ccCompilationInfo.getDeclaredIncludeDirs();
}
/**
- * Return the directories in which to look for headers and issue a warning.
- * (pertains to headers not specifically listed in {@code
- * declaredIncludeSrcs}). The return value may contain duplicate elements.
+ * Return the directories in which to look for headers and issue a warning. (pertains to headers
+ * not specifically listed in {@code declaredIncludeSrcs}).
*/
public NestedSet<PathFragment> getDeclaredIncludeWarnDirs() {
return ccCompilationInfo.getDeclaredIncludeWarnDirs();
}
- /**
- * Return explicit header files (i.e., header files explicitly listed). The
- * return value may contain duplicate elements.
- */
+ /** Return explicitly listed header files. */
@Override
public NestedSet<Artifact> getDeclaredIncludeSrcs() {
if (lipoScannables != null && lipoScannables.iterator().hasNext()) {