From f850d6ea7205bdb6ebb6473024dc605c09990b5b Mon Sep 17 00:00:00 2001 From: Yin-Chia Yeh Date: Thu, 3 Aug 2017 18:07:45 -0700 Subject: [PATCH] Camera: update NDK docs Add type information to the doc paragraph. Bug: 64304111 Test: build (doc only change) Change-Id: Ifc3b8068d308ad2571ad66ddf5850b1cdc4163d6 --- camera/docs/metadata_helpers.py | 1 + camera/docs/ndk_camera_metadata_tags.mako | 24 ++++++++++++++++++++---- 2 files changed, 21 insertions(+), 4 deletions(-) diff --git a/camera/docs/metadata_helpers.py b/camera/docs/metadata_helpers.py index a501524b..22d636f7 100644 --- a/camera/docs/metadata_helpers.py +++ b/camera/docs/metadata_helpers.py @@ -904,6 +904,7 @@ def ndkdoc(metadata, indent = 4): """ def ndkdoc_formatter(text): # render with markdown => HTML + # Turn off the table plugin since doxygen doesn't recognize generated tags ndktext = md(text, NDKDOC_IMAGE_SRC_METADATA, False) # Convert metadata entry "android.x.y.z" to form diff --git a/camera/docs/ndk_camera_metadata_tags.mako b/camera/docs/ndk_camera_metadata_tags.mako index 8232e508..f2ba1b0f 100644 --- a/camera/docs/ndk_camera_metadata_tags.mako +++ b/camera/docs/ndk_camera_metadata_tags.mako @@ -36,13 +36,20 @@ #ifndef _NDK_CAMERA_METADATA_TAGS_H #define _NDK_CAMERA_METADATA_TAGS_H + +#include + +__BEGIN_DECLS + +#if __ANDROID_API__ >= 24 <%! + from metadata_helpers import csym def annotated_type(entry): type = entry.type if entry.container == 'array': type += '[' + '*'.join(entry.container_sizes) + ']' if entry.enum: - type += ' (enum)' + type += ' (acamera_metadata_enum_%s_t)'%(csym(entry.name).lower()) return type %>\ @@ -85,9 +92,13 @@ typedef enum acamera_metadata_tag { % else: % if entry.description or entry.details: /** + % if entry.description: ${entry.description | ndkdoc(metadata)}\ + % endif * - *

This tag may appear in:

+ *

Type: ${annotated_type(entry)}

+ * + *

This tag may appear in: *

+ *

* + % if entry.details: ${entry.details | ndkdoc(metadata)}\ + % endif */ % endif ${ndk(entry.name) + " = " | csym,ljust(60)}// ${annotated_type(entry)} @@ -179,7 +192,10 @@ ${val.notes | ndkdoc(metadata)}\ % endfor % endfor +#endif /* __ANDROID_API__ >= 24 */ + +__END_DECLS -#endif //_NDK_CAMERA_METADATA_TAGS_H +#endif /* _NDK_CAMERA_METADATA_TAGS_H */ /** @} */ -- 2.11.0