summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
author Dan Albert <danalbert@google.com> 2024-09-11 23:07:50 +0000
committer Gerrit Code Review <noreply-gerritcodereview@google.com> 2024-09-11 23:07:50 +0000
commit04e52144b6b91ab96fcd1568daac2a8cb27e6bee (patch)
treee60ea4c2777782d5be509d48ec0149730e6ce0a6
parent6ad2e30de377b868d31cf1e1745a5b4600b1f4fb (diff)
parent69454c2938ea30afbd21d86c93179a14afbeab0b (diff)
Merge "Improve the docs about when to use introduced." into main
-rw-r--r--docs/map_files.md17
1 files changed, 11 insertions, 6 deletions
diff --git a/docs/map_files.md b/docs/map_files.md
index e1ddefc27..8d6af879f 100644
--- a/docs/map_files.md
+++ b/docs/map_files.md
@@ -88,12 +88,17 @@ but is useful when developing APIs for an unknown future release.
### introduced
-Indicates the version in which an API was first introduced. For example,
-`introduced=21` specifies that the API was first added (or first made public) in
-API level 21. This tag can be applied to either a version definition or an
-individual symbol. If applied to a version, all symbols contained in the version
-will have the tag applied. An `introduced` tag on a symbol overrides the value
-set for the version, if both are defined.
+Indicates the version in which an API was first introduced in the NDK. For
+example, `introduced=21` specifies that the API was first added (or first made
+public) in API level 21. This tag can be applied to either a version definition
+or an individual symbol. If applied to a version, all symbols contained in the
+version will have the tag applied. An `introduced` tag on a symbol overrides the
+value set for the version, if both are defined.
+
+The `introduced` tag should only be used with NDK APIs. Other API surface tags
+(such as `apex`) will override `introduced`. APIs that are in the NDK should
+never use tags like `apex`, and APIs that are not in the NDK should never use
+`introduced`.
Note: The map file alone does not contain all the information needed to
determine which API level an API was added in. The `first_version` property of