diff options
Diffstat (limited to 'src/ibusobject.h')
| -rw-r--r-- | src/ibusobject.h | 35 |
1 files changed, 34 insertions, 1 deletions
diff --git a/src/ibusobject.h b/src/ibusobject.h index 67fb95b..38cdfac 100644 --- a/src/ibusobject.h +++ b/src/ibusobject.h @@ -17,6 +17,13 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ +/** + * SECTION: ibusobject + * @short_description: Base Object of iBus. + * @stability: Stable + * + * Base object handling functions of iBus. + */ #ifndef __IBUS_OBJECT_H_ #define __IBUS_OBJECT_H_ @@ -73,6 +80,12 @@ struct _IBusObject { typedef void ( *IBusObjectDestroyFunc) (IBusObject *); + +/** + * IBusObjectClass: + * @destroy: IBus object destroy method, usually implemented by subclass. + * + */ struct _IBusObjectClass { GObjectClass parent; @@ -84,8 +97,28 @@ struct _IBusObjectClass { gpointer pdummy[7]; }; -GType ibus_object_get_type (void); +/** + * ibus_object_get_type: + * @returns: GType for IBusObject + * + * Returns GType for IBusObject. + */ + GType ibus_object_get_type (void); + +/** + * ibus_object_new: + * @returns: A newly allocated IBusObject + * + * Returns a newly allocated IBusObject. + */ IBusObject *ibus_object_new (void); + +/** + * ibus_object_destory: + * @object: IBusObject to be destroy. + * + * Destroy an IBusObject. + */ void ibus_object_destroy (IBusObject *object); G_END_DECLS |