Skip to content

Commit

Permalink
Update javadoc for some headers and include dirs methods.
Browse files Browse the repository at this point in the history
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
  • Loading branch information
benjaminp authored and Copybara-Service committed Feb 22, 2018
1 parent 0cf94e9 commit 93a6730
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 32 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -174,40 +174,24 @@ public ImmutableList<PathFragment> getSystemIncludeDirs() {
}

/**
* 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;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1076,27 +1076,22 @@ protected String getRawProgressMessage() {
}

/**
* 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()) {
Expand Down

0 comments on commit 93a6730

Please sign in to comment.