Camera2: Deprecate LENS_RADIAL_DISTORTION, add LENS_DISTORTION

[android-x86/system-media.git] / camera / docs / CameraMetadataKeys.mako

diff --git a/camera/docs/CameraMetadataKeys.mako b/camera/docs/CameraMetadataKeys.mako
index 51b314e..6006c8d 100644 (file)
--- a/camera/docs/CameraMetadataKeys.mako
+++ b/camera/docs/CameraMetadataKeys.mako
@@ -28,34 +28,47 @@
 ## Generate a single key and docs
 <%def name="generate_key(entry)">\
     /**
-  % if entry.description:
-${entry.description | javadoc}\
-  % endif
-  % if entry.details:
-${entry.details | javadoc}\
-  % endif
+<%
+    # Dedent fixes markdown not to generate code blocks. Then do the rest.
+    description = ""
+    if entry.description:
+        description = dedent(entry.description) + "\n\n"
+    details = ""
+    if entry.details:
+        details = dedent(entry.details)
+    # Unconditionally add extra information if necessary
+    extra_detail = generate_extra_javadoc_detail(entry)("")
+
+    concatenated_info = description + details + extra_detail
+%>\
+## Glue description and details together before javadoc-izing. Otherwise @see in middle of javadoc.
+${concatenated_info | javadoc(metadata)}\
   % if entry.enum and not (entry.typedef and entry.typedef.languages.get('java')):
     % for value in entry.enum.values:
+     % if not value.hidden:
      * @see #${jenum_value(entry, value)}
+     % endif
     % endfor
   % endif
-  % if entry.optional:
-     *
-     * <b>Optional</b> - This value may be null on some devices.
-  % endif
-  % if any(tag.name == 'FULL' for tag in entry.tags):
-     *
-     * <b>{@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL}</b> -
-     * Present on all devices that report being FULL level hardware devices in the
-     * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL HARDWARE_LEVEL} key.
+  % 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}", ${jclass(entry)});
+            new Key<${jtype_boxed(entry)}>("${entry.name}", ${jkey_type_token(entry)});
 </%def>\
 ##
 ## Generate a list of only Static, Controls, or Dynamic properties.
@@ -63,17 +76,17 @@ ${entry.details | javadoc}\
 % 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