C/C++ API

/**
 * @addtogroup 模块名
 * @{
 * 
 * @brief 一句话描述该模块的作用。
 * 
 * （必选）详细描述该模块的主要功能、使用场景和使用建议。
 *  例如：xxx模块提供xxx能力，包括xxx、xxx等。当需要xx时，可使用本模块的接口xxx。本模块接口可与xxx联合使用，实现xxx。
 *
 * @since OS的版本号
 * @version 库的版本号
 */
...
/** @} */

/**
 * @addtogroup bitmap
 * @{
 *
 * @brief ANativeWindow represents the producer end of an image queue.
 *
 * It is the C counterpart of the android.view.Surface object in Java,
 * and can be converted both ways. Depending on the consumer, images
 * submitted to ANativeWindow can be shown on the display or sent to
 * other consumers, such as video encoders.
 *
 * @since 1.0
*/
intAndroidBitmap_unlock(JNIEnv*env, jobjectjbitmap);
...
/** @} */

/**
 * @file 文件名
 *
 * @brief 一句话描述该头文件的作用。
 *
 * （必选）详细描述该头文件的主要功能、使用场景和使用建议。
 * 
 * @since OS的版本号
 * @version 库的版本号
 */

/**
 * @file bitmap.h
 *
 * @brief API for accessing a native window.
 * 
 * @since 1.0
 * @version 1.0
 */

/**
 * @brief 一句话描述该常量/变量的含义。
 * 
 * （可选）详细描述该常量/变量的作用、使用限制和建议、取值范围，以及取到边界值、非法值的后果。
 */
<const> int gExample;

/**
 * @brief The name of the function that NativeInstance looks for when launching its
 * native code.
 *
 * This is the default function that is used, you can specify "android.app.func_name"
 * string meta-data in your manifest to use a different function.
 */
extern ANativeActivity_createFunc ANativeActivity_onCreate;

/**
 * @brief 一句话描述该枚举的作用。
 * 
 * （可选）详细描述该枚举的主要功能、使用场景和使用建议。
 */
enum EnumName 
{
/** 描述枚举值1的含义 */
EnumMermber1 = 1, 
/** 描述枚举值2的含义 */
EnumMermber2, 
/** 描述枚举值3的含义 */
EnumMermber3
}; 

/**
 * @brief Flags for ANativeActivity_showSoftInput; see the Java InputMethodManager
 * API for documentation.
 */
enum {
/**
 * Implicit request to show the input window, not as the result
 * of a direct request by the user.
 */
ANATIVEACTIVITY_SHOW_SOFT_INPUT_IMPLICIT = 0x0001,
/**
 * The user has forced the input method open (such as by
 * long-pressing menu) so it should not be closed until they
 * explicitly do so.
 */
ANATIVEACTIVITY_SHOW_SOFT_INPUT_FORCED = 0x0002,
};

/**
 * @brief 一句话描述该结构体或联合体的作用。
 *
 * （可选）详细描述该结构体或联合体的作用、使用场合和建议等。
 */
Typedef struct StructName
{ 
/** 描述成员1的含义 */
unsigned long StructMember1;
/** 描述成员2的含义 */
unsigned long StructMember2;
};

/**
 * @brief These are the callbacks the framework makes into a native application.
 * 
 * All of these callbacks happen on the main thread of the application.
 * By default, all callbacks are NULL; set to a pointer to your own function
 * to have it called.
 */
typedef struct ANativeActivityCallbacks {
/**
 * NativeActivity has started. See Java documentation for Activity.onStart()
 * for more information.
 */
void (*onStart)(ANativeActivity*activity);
/**
 * NativeActivity has resumed. See Java documentation for Activity.onResume()
 * for more information.
 */
void (*onResume)(ANativeActivity*activity);
} ANativeActivityCallbacks;

/**
 * @brief 一句话描述该函数的作用。
 *
 * 详细描述该函数的主要功能、使用场景和使用建议。
 *
 * @param （可选）后接参数名和参数描述，一个参数使用一个@param标记。参数描述写作要点：1.参数的作用、使用限制和建议；2.参数的取值范围，以及取到边界值、非法值的后果；3.如果存在参数设置方面的建议值或经验值，请描述。如果该方法没有参数，则请删除该标记。
 * 
 * @return（可选）后接返回值类型和返回值描述，一个返回值使用一个@return标记。返回值描述介绍返回值的含义，如果该方法没有返回值，则请删除该标记。
 *
 * @see （可选）当存在与该方法相关联的函数时（功能相近或者存在关系），可以通过@see建立到参考方法的链接。如果不涉及，则请删除该标记。
 * 
 * @since API Version
 */
int function (int param1, int param2);

/**
 * @brief Allocate dynamic memory.
 *
 * This API is used to allocate a memory block of which the size is specified and update module mem used.
 *
 * @param  pool      Pointer to the memory pool that contains the memory block to be allocated.
 * @param  size      Size of the memory block to be allocated (unit: byte).
 * @param  moduleID  module ID (0~MODULE_MAX).
 *
 * @return Returns VOID* if memory is successfully allocated with the starting address of the allocated memory block.
 * @return Returns NULL if memory fails to be allocated.
 *                  
 * @see LOS_MemRealloc | LOS_MemAllocAlign | LOS_MemFree
 * 
 * since 1.0
 */
extern VOID *LOS_MemMalloc(VOID *pool, UINT32 size, UINT32 moduleID);

/**
 * @brief 获取组件参数设置。
 *
 * 当组件处于除OMX_StateInvalid（组件状态异常）之外的其他状态，用户可通过此接口获取组件参数，组件状态详见{@link OMX_STATETYPE}。
 *
 * @param index 待填充结构的索引，详见OMX IL定义的OMX_INDEXTYPE。
 * @param inParamStruct 指向由组件填充的应用程序分配的结构体指针。
 * @param outParamStruct 指向由组件填充的应用程序分配的结构体指针。
 *
 * @return HDF_SUCCESS 表示获取参数成功。
 * @return HDF_ERR_INVALID_PARAM 表示参数无效，获取参数失败。
 * @return HDF_FAILURE 表示执行失败。
 * @return 其他值表示底层返回失败，具体错误码详见OpenMAX IL定义的OMX_ERRORTYPE。
 *
 * @since 3.2
 */