diff options
| author | 2023-10-31 19:25:45 +0000 | |
|---|---|---|
| committer | 2023-10-31 19:25:45 +0000 | |
| commit | 69454c2938ea30afbd21d86c93179a14afbeab0b (patch) | |
| tree | 76c34890c31d0537acaacda773798102ab565dde | |
| parent | 78567011cfdfe491565c1560544a8d104002aeff (diff) | |
Improve the docs about when to use introduced.
Bug: None
Test: None
Change-Id: I90eeb24c0fce8f17576f6e4c98e04aa2855a4e8c
| -rw-r--r-- | docs/map_files.md | 17 |
1 files changed, 11 insertions, 6 deletions
diff --git a/docs/map_files.md b/docs/map_files.md index 35e8cbbfc..c5ccdb62d 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 |