Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Adds a way to exclude test directories from javadoc.

Browse Source 
By adding a file named NO_DOCS to a directory, all
java files under that directory will be ignored for
javadoc builds. This is especially useful for marking
test projects as not participating in the javadoc
build.

Change-Id: I3b0259f4bb3c8460c3560fdcf97c6cac11d8001d
This commit is contained in:
George Mount
2015-12-03 07:39:55 -08:00
parent 29ed07524c
commit f6be993407
1 changed files with 16 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
Android.mk
View File

@@ -669,6 +669,16 @@ dirs_to_check_apis := \
$(fwbase_dirs_to_document) \ $(fwbase_dirs_to_document) \
$(non_base_dirs) $(non_base_dirs)
###########################################################
## Return all directories that have a 'NO_DOCS' file in
## them, appending a '%' to them to form a pattern to
## filter out files under those directories.
## $(1): A list of base directories to look at.
###########################################################
define find-no-docs-pattern
$(addsuffix %, $(dir $(foreach dir, $(1), $(shell cd $(LOCAL_PATH); find $(dir) -name NO_DOCS))))
endef
# These are relative to frameworks/base # These are relative to frameworks/base
# FRAMEWORKS_BASE_SUBDIRS comes from build/core/pathmap.mk # FRAMEWORKS_BASE_SUBDIRS comes from build/core/pathmap.mk
dirs_to_document := \ dirs_to_document := \
@@ -676,6 +686,9 @@ dirs_to_document := \
$(addprefix ../../, $(FRAMEWORKS_DATA_BINDING_JAVA_SRC_DIRS)) \ $(addprefix ../../, $(FRAMEWORKS_DATA_BINDING_JAVA_SRC_DIRS)) \
$(addprefix ../../, $(FRAMEWORKS_SUPPORT_JAVA_SRC_DIRS)) \ $(addprefix ../../, $(FRAMEWORKS_SUPPORT_JAVA_SRC_DIRS)) \
patterns_to_not_document := \
$(call find-no-docs-pattern, $(dirs_to_document))
# These are relative to frameworks/base # These are relative to frameworks/base
html_dirs := \ html_dirs := \
$(FRAMEWORKS_BASE_SUBDIRS) \ $(FRAMEWORKS_BASE_SUBDIRS) \
@@ -689,9 +702,11 @@ common_src_files := \
# These are relative to frameworks/base # These are relative to frameworks/base
framework_docs_LOCAL_SRC_FILES := \ framework_docs_LOCAL_SRC_FILES := \
$(call find-other-java-files, $(dirs_to_document)) \ $(filter-out $(patterns_to_not_document), $(call find-other-java-files, $(dirs_to_document))) \
$(common_src_files) $(common_src_files)
# $(call find-other-java-files, $(dirs_to_document)) \
# These are relative to frameworks/base # These are relative to frameworks/base
framework_docs_LOCAL_API_CHECK_SRC_FILES := \ framework_docs_LOCAL_API_CHECK_SRC_FILES := \
$(call find-other-java-files, $(dirs_to_check_apis)) \ $(call find-other-java-files, $(dirs_to_check_apis)) \