OSDN Git Service

Camera2: Deprecate LENS_RADIAL_DISTORTION, add LENS_DISTORTION
[android-x86/system-media.git] / camera / docs / CameraMetadataKeys.mako
index 89c0ced..6006c8d 100644 (file)
      * modify the comment blocks at the start or end.
      *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~*/
 
-<%!
-  ##
-  ## Generate extra text blocks for the details field
-  def generate_extra_detail(entry):
-    def inner(text):
-      if entry.optional:
-        text += '\n\n<b>Optional</b> - This value may be {@code null} on some devices.\n'
-      if any(tag.name == 'FULL' for tag in entry.tags):
-        text += \
-          '\n<b>Full capability</b> - \n' + \
-          'Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the\n' + \
-          'android.info.supportedHardwareLevel key\n'
-      return text
-    return inner
-%>
 ##
 ## Generate a single key and docs
 <%def name="generate_key(entry)">\
@@ -52,7 +37,7 @@
     if entry.details:
         details = dedent(entry.details)
     # Unconditionally add extra information if necessary
-    extra_detail = generate_extra_detail(entry)("")
+    extra_detail = generate_extra_javadoc_detail(entry)("")
 
     concatenated_info = description + details + extra_detail
 %>\
@@ -67,14 +52,21 @@ ${concatenated_info | javadoc(metadata)}\
   % endif
   % if entry.deprecated:
      * @deprecated
+${entry.deprecation_description | javadoc(metadata)}
   % endif
-  % if entry.applied_visibility == 'hidden':
+  % if entry.applied_visibility in ('hidden', 'ndk_public'):
      * @hide
   % endif
      */
   % if entry.deprecated:
     @Deprecated
   % endif
+  % if entry.applied_visibility in ('public', 'java_public'):
+    @PublicKey
+  % endif
+  % if entry.synthetic:
+    @SyntheticKey
+  % endif
     public static final Key<${jtype_boxed(entry)}> ${entry.name | jkey_identifier} =
             new Key<${jtype_boxed(entry)}>("${entry.name}", ${jkey_type_token(entry)});
 </%def>\
@@ -84,17 +76,17 @@ ${concatenated_info | javadoc(metadata)}\
 % for outer_namespace in metadata.outer_namespaces: ## assumes single 'android' namespace
   % for section in outer_namespace.sections:
     % if section.find_first(lambda x: isinstance(x, metadata_model.Entry) and x.kind == xml_name) and \
-         any_visible(section, xml_name, ('public','hidden') ):
+         any_visible(section, xml_name, ('public','hidden','ndk_public','java_public') ):
       % for inner_namespace in get_children_by_filtering_kind(section, xml_name, 'namespaces'):
 ## We only support 1 level of inner namespace, i.e. android.a.b and android.a.b.c works, but not android.a.b.c.d
 ## If we need to support more, we should use a recursive function here instead.. but the indentation gets trickier.
-        % for entry in filter_visibility(inner_namespace.merged_entries, ('hidden','public')):
+        % for entry in filter_visibility(inner_namespace.merged_entries, ('hidden','public', 'ndk_public', 'java_public')):
 ${generate_key(entry)}
        % endfor
     % endfor
     % for entry in filter_visibility( \
         get_children_by_filtering_kind(section, xml_name, 'merged_entries'), \
-                                         ('hidden', 'public')):
+                                         ('hidden', 'public', 'ndk_public', 'java_public')):
 ${generate_key(entry)}
     % endfor
     % endif