From fafdebc5741aef1b6eb64db0a0447eb0210ee186 Mon Sep 17 00:00:00 2001 From: monsta Date: Tue, 23 Aug 2016 16:02:36 +0300 Subject: libcaja-extension: fix docs generation and fix some indent docs are still far from perfect, but most build warnings are gone --- libcaja-extension/caja-extension-types.h | 75 ++++++++++++++++++++------------ 1 file changed, 46 insertions(+), 29 deletions(-) (limited to 'libcaja-extension/caja-extension-types.h') diff --git a/libcaja-extension/caja-extension-types.h b/libcaja-extension/caja-extension-types.h index ddfbd233..691d0f11 100644 --- a/libcaja-extension/caja-extension-types.h +++ b/libcaja-extension/caja-extension-types.h @@ -31,43 +31,60 @@ #include -#ifdef __cplusplus -extern "C" { -#endif +G_BEGIN_DECLS #define CAJA_TYPE_OPERATION_RESULT (caja_operation_result_get_type ()) - /* Handle for asynchronous interfaces. These are opaque handles that must - * be unique within an extension object. These are returned by operations - * that return CAJA_OPERATION_IN_PROGRESS */ - typedef struct _CajaOperationHandle CajaOperationHandle; +/** + * CajaOperationHandle: + * + * Handle for asynchronous interfaces. These are opaque handles that must + * be unique within an extension object. These are returned by operations + * that return CAJA_OPERATION_IN_PROGRESS. + */ +typedef struct _CajaOperationHandle CajaOperationHandle; + +/** + * CajaOperationResult: + * @CAJA_OPERATION_COMPLETE: the operation succeeded, and the extension + * is done with the request. + * @CAJA_OPERATION_FAILED: the operation failed. + * @CAJA_OPERATION_IN_PROGRESS: the extension has begin an async operation. + * When this value is returned, the extension must set the handle parameter + * and call the callback closure when the operation is complete. + */ +typedef enum { + /* Returned if the call succeeded, and the extension is done + * with the request */ + CAJA_OPERATION_COMPLETE, - typedef enum - { - /* Returned if the call succeeded, and the extension is done - * with the request */ - CAJA_OPERATION_COMPLETE, + /* Returned if the call failed */ + CAJA_OPERATION_FAILED, - /* Returned if the call failed */ - CAJA_OPERATION_FAILED, + /* Returned if the extension has begun an async operation. + * If this is returned, the extension must set the handle + * parameter and call the callback closure when the + * operation is complete. */ + CAJA_OPERATION_IN_PROGRESS +} CajaOperationResult; - /* Returned if the extension has begun an async operation. - * If this is returned, the extension must set the handle - * parameter and call the callback closure when the - * operation is complete. */ - CAJA_OPERATION_IN_PROGRESS - } CajaOperationResult; +GType caja_operation_result_get_type (void); - GType caja_operation_result_get_type (void); +/** + * SECTION:caja-extension-types + * @title: CajaModule + * @short_description: Initialize an extension + * @include: libcaja-extension/caja-extension-types.h + * + * Methods that each extension implements. + */ - void caja_module_initialize (GTypeModule *module); - void caja_module_shutdown (void); - void caja_module_list_types (const GType **types, - int *num_types); - void caja_module_list_pyfiles (GList **pyfiles); +void caja_module_initialize (GTypeModule *module); +void caja_module_shutdown (void); +void caja_module_list_types (const GType **types, + int *num_types); +void caja_module_list_pyfiles (GList **pyfiles); -#ifdef __cplusplus -} -#endif +G_END_DECLS #endif -- cgit v1.2.1