Fix gir annotations.

TEST=g-ir-scanner@src Review URL: https://codereview.appspot.com/18100044
2013-11-05 18:12:41 +09:00 · 2013-11-05 18:12:41 +09:00 · f35184a187
--- a/engine/Makefile.am
+++ b/engine/Makefile.am
@ -84,11 +84,11 @@ test_compose_SOURCES = \
        $(NULL)
 test_compose_CFLAGS = \
        $(AM_CFLAGS) \
-	@GTK3_CFLAGS@ \
+        @GTK3_CFLAGS@ \
        $(NULL)
 test_compose_LDADD = \
        $(AM_LDADD) \
-	@GTK3_LIBS@ \
+        @GTK3_LIBS@ \
        $(NULL)
 test_compose_VALAFLAGS = \
        $(AM_VALAFLAGS) \
--- a/src/ibusattribute.h
+++ b/src/ibusattribute.h
@ -1,8 +1,8 @@
 /* -*- mode: C; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
 /* vim:set et sts=4: */
 /* IBus - The Input Bus
- * Copyright (C) 2008-2010 Peng Huang <shawn.p.huang@gmail.com>
- * Copyright (C) 2008-2010 Red Hat, Inc.
+ * Copyright (C) 2008-2013 Peng Huang <shawn.p.huang@gmail.com>
+ * Copyright (C) 2008-2013 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
@ -24,6 +24,9 @@
 #error "Only <ibus.h> can be included directly"
 #endif

+#ifndef __IBUS_ATTRIBUTE_H_
+#define __IBUS_ATTRIBUTE_H_
+
 /**
 * SECTION: ibusattribute
 * @short_description: Attributes of IBusText.
@ -31,10 +34,9 @@
 * @stability: Stable
 *
 * An IBusAttribute represents an attribute that associate to IBusText.
- * It decorates preedit buffer and auxiliary text with underline, foreground and background colors.
+ * It decorates preedit buffer and auxiliary text with underline, foreground
+ * and background colors.
 */
-#ifndef __IBUS_ATTRIBUTE_H_
-#define __IBUS_ATTRIBUTE_H_

 #include "ibusserializable.h"

--- a/src/ibusattrlist.h
+++ b/src/ibusattrlist.h
@ -1,8 +1,8 @@
 /* -*- mode: C; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
 /* vim:set et sts=4: */
 /* IBus - The Input Bus
- * Copyright (C) 2008-2010 Peng Huang <shawn.p.huang@gmail.com>
- * Copyright (C) 2008-2010 Red Hat, Inc.
+ * Copyright (C) 2008-2013 Peng Huang <shawn.p.huang@gmail.com>
+ * Copyright (C) 2008-2013 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
@ -24,6 +24,9 @@
 #error "Only <ibus.h> can be included directly"
 #endif

+#ifndef __IBUS_ATTRIBUTE_LIST_H_
+#define __IBUS_ATTRIBUTE_LIST_H_
+
 /**
 * SECTION: ibusattrlist
 * @Title: IBusAttrList
@ -32,8 +35,6 @@
 * @Stability: Stable
 *
 */
-#ifndef __IBUS_ATTRIBUTE_LIST_H_
-#define __IBUS_ATTRIBUTE_LIST_H_

 #include "ibusattribute.h"

--- a/src/ibuscomponent.h
+++ b/src/ibuscomponent.h
@ -1,8 +1,8 @@
 /* -*- mode: C; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
 /* vim:set et sts=4: */
 /* bus - The Input Bus
- * Copyright (C) 2008-2010 Peng Huang <shawn.p.huang@gmail.com>
- * Copyright (C) 2008-2010 Red Hat, Inc.
+ * Copyright (C) 2008-2013 Peng Huang <shawn.p.huang@gmail.com>
+ * Copyright (C) 2008-2013 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
@ -24,6 +24,9 @@
 #error "Only <ibus.h> can be included directly"
 #endif

+#ifndef __IBUS_COMPONENT_H_
+#define __IBUS_COMPONENT_H_
+
 /**
 * SECTION: ibuscomponent
 * @short_description:  Component (executable) specification.
@ -41,8 +44,6 @@
 * The format of a component XML file is described  at
 * <ulink url="http://code.google.com/p/ibus/wiki/DevXML">http://code.google.com/p/ibus/wiki/DevXML</ulink>
 */
-#ifndef __IBUS_COMPONENT_H_
-#define __IBUS_COMPONENT_H_

 #include "ibusserializable.h"
 #include "ibusobservedpath.h"
--- a/src/ibusconfig.h
+++ b/src/ibusconfig.h
@ -1,8 +1,8 @@
 /* -*- mode: C; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
 /* vim:set et sts=4: */
 /* ibus - The Input Bus
- * Copyright (C) 2008-2010 Peng Huang <shawn.p.huang@gmail.com>
- * Copyright (C) 2008-2010 Red Hat, Inc.
+ * Copyright (C) 2008-2013 Peng Huang <shawn.p.huang@gmail.com>
+ * Copyright (C) 2008-2013 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
@ -24,6 +24,9 @@
 #error "Only <ibus.h> can be included directly"
 #endif

+#ifndef __IBUS_CONFIG_H_
+#define __IBUS_CONFIG_H_
+
 /**
 * SECTION: ibusconfig
 * @title: IBusConfig
@ -34,8 +37,6 @@
 *
 * Currently, IBusConfig supports gconf.
 */
-#ifndef __CONFIG_H_
-#define __CONFIG_H_

 #include "ibusproxy.h"

@ -116,7 +117,6 @@ void             ibus_config_new_async      (GDBusConnection    *connection,
 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback pass to
 *      ibus_config_new_async().
 * @error: Return location for error or %NULL.
- *
 * @returns: A newly allocated #IBusConfig.
 *
 * Finishes an operation started with ibus_config_new_async().
--- a/src/ibusconfigservice.h
+++ b/src/ibusconfigservice.h
@ -1,8 +1,8 @@
 /* -*- mode: C; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
 /* vim:set et sts=4: */
 /* ibus - The Input Bus
- * Copyright (C) 2008-2010 Peng Huang <shawn.p.huang@gmail.com>
- * Copyright (C) 2008-2010 Red Hat, Inc.
+ * Copyright (C) 2008-2013 Peng Huang <shawn.p.huang@gmail.com>
+ * Copyright (C) 2008-2013 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
@ -24,6 +24,9 @@
 #error "Only <ibus.h> can be included directly"
 #endif

+#ifndef __IBUS_CONFIG_SERVICE_H_
+#define __IBUS_CONFIG_SERVICE_H_
+
 /**
 * SECTION: ibusconfigservice
 * @short_description: Configuration service back-end.
@ -95,8 +98,8 @@
 *             <varlistentry>
 *                 <term>Returns:</term>
 *                 <listitem>TRUE if succeed; FALSE otherwise.</listitem>
-*             </varlistentry>
-*         </variablelist>
+ *             </varlistentry>
+ *        </variablelist>
 *        <para>Get value of a configuration option.
 *        </para>
 *     </listitem>
@ -131,8 +134,6 @@
 *     </listitem>
 * </itemizedlist>
 */
-#ifndef __IBUS_CONFIG_SERVICE_H_
-#define __IBUS_CONFIG_SERVICE_H_

 #include "ibusservice.h"

@ -188,7 +189,6 @@ struct _IBusConfigServiceClass {
     * @config: An IBusConfig.
     * @section: section name
     * @name: value name
-     *
     * @returns: (transfer full): The value in config associated with section and name.
     *
     */
--- a/src/ibusdebug.h
+++ b/src/ibusdebug.h
@ -1,8 +1,8 @@
 /* -*- mode: C; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
 /* vim:set et sts=4: */
 /* ibus - The Input Bus
- * Copyright (C) 2008-2010 Peng Huang <shawn.p.huang@gmail.com>
- * Copyright (C) 2008-2010 Red Hat, Inc.
+ * Copyright (C) 2008-2013 Peng Huang <shawn.p.huang@gmail.com>
+ * Copyright (C) 2008-2013 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
@ -24,6 +24,9 @@
 #error "Only <ibus.h> can be included directly"
 #endif

+#ifndef __IBUS_DEBUG_H_
+#define __IBUS_DEBUG_H_
+
 /**
 * SECTION: ibusdebug
 * @short_description: Debug message output.
@ -31,8 +34,6 @@
 *
 * This section lists functions that generate debug and warning messages.
 */
-#ifndef __IBUS_DEBUG_H_
-#define __IBUS_DEBUG_H_

 /**
 * ibus_warning:
--- a/src/ibusengine.h
+++ b/src/ibusengine.h
@ -24,6 +24,9 @@
 #error "Only <ibus.h> can be included directly"
 #endif

+#ifndef __IBUS_ENGINE_H_
+#define __IBUS_ENGINE_H_
+
 /**
 * SECTION: ibusengine
 * @short_description: Input method engine abstract.
@ -35,8 +38,6 @@
 *
 * see_also: #IBusComponent, #IBusEngineDesc
 */
-#ifndef __IBUS_ENGINE_H_
-#define __IBUS_ENGINE_H_

 #include "ibusservice.h"
 #include "ibusattribute.h"
--- a/src/ibusenginedesc.h
+++ b/src/ibusenginedesc.h
@ -1,8 +1,8 @@
 /* -*- mode: C; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
 /* vim:set et sts=4: */
 /* bus - The Input Bus
- * Copyright (C) 2008-2010 Peng Huang <shawn.p.huang@gmail.com>
- * Copyright (C) 2008-2010 Red Hat, Inc.
+ * Copyright (C) 2008-2013 Peng Huang <shawn.p.huang@gmail.com>
+ * Copyright (C) 2008-2013 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
@ -24,6 +24,9 @@
 #error "Only <ibus.h> can be included directly"
 #endif

+#ifndef __IBUS_ENGINE_DESC_H_
+#define __IBUS_ENGINE_DESC_H_
+
 /**
 * SECTION: ibusenginedesc
 * @short_description:  Input method engine description data.
@ -39,13 +42,10 @@
 * using ibus_component_new_from_file() to load a component file,
 * which also includes engine description data.
 *
- * @see_also: #IBusComponent, #IBusEngine
+ * see_also: #IBusComponent, #IBusEngine
 *
 */

-#ifndef __ENGINE_DESC_H_
-#define __ENGINE_DESC_H_
-
 #include "ibusserializable.h"
 #include "ibusxml.h"

--- a/src/ibusenumtypes.h.template
+++ b/src/ibusenumtypes.h.template
@ -1,4 +1,7 @@
 /*** BEGIN file-header ***/
+#ifndef __IBUS_ENUM_TYPES_H__
+#define __IBUS_ENUM_TYPES_H__
+
 /**
 * SECTION: ibusenumtypes
 * @short_description: Enumeration definition in IBus.
@ -6,8 +9,6 @@
 *
 * IBusEnumTypes lists IBus enumeration types.
 */
-#ifndef __IBUS_ENUM_TYPES_H__
-#define __IBUS_ENUM_TYPES_H__

 #include <glib-object.h>

--- a/src/ibuserror.h
+++ b/src/ibuserror.h
@ -1,7 +1,7 @@
 /* -*- mode: C; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
 /* vim:set et sts=4: */
 /* ibus - The Input Bus
- * Copyright (C) 2011 Peng Huang <shawn.p.huang@gmail.com>
+ * Copyright (C) 2011-2013 Peng Huang <shawn.p.huang@gmail.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
@ -23,18 +23,17 @@
 #error "Only <ibus.h> can be included directly"
 #endif

-/**
- * SECTION: ibusshare
- * @short_description: Shared utility functions and definition.
- * @stability: Stable
- *
- * This file defines some utility functions and definition
- * which are shared among ibus component and services.
- */
-
 #ifndef __IBUS_ERROR_H_
 #define __IBUS_ERROR_H_

+/**
+ * SECTION: ibuserror
+ * @short_description: Error functions and definition.
+ * @stability: Stable
+ *
+ * This file defines some error functions and definition.
+ */
+
 #include <glib.h>

 G_BEGIN_DECLS
--- a/src/ibusfactory.h
+++ b/src/ibusfactory.h
@ -1,8 +1,8 @@
 /* -*- mode: C; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
 /* vim:set et sts=4: */
 /* ibus - The Input Bus
- * Copyright (C) 2008-2010 Peng Huang <shawn.p.huang@gmail.com>
- * Copyright (C) 2008-2010 Red Hat, Inc.
+ * Copyright (C) 2008-2013 Peng Huang <shawn.p.huang@gmail.com>
+ * Copyright (C) 2008-2013 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
@ -24,6 +24,9 @@
 #error "Only <ibus.h> can be included directly"
 #endif

+#ifndef __IBUS_FACTORY_H_
+#define __IBUS_FACTORY_H_
+
 /**
 * SECTION: ibusfactory
 * @short_description: Factory for creating engine instances.
@ -34,11 +37,9 @@
 * It provides CreateEngine remote method, which creates an IME instance by name,
 * and returns the D-Bus object path to IBus daemon.
 *
- * @see_also: #IBusEngine
+ * see_also: #IBusEngine
 *
 */
-#ifndef __IBUS_FACTORY_H_
-#define __IBUS_FACTORY_H_

 #include "ibusservice.h"
 #include "ibusserializable.h"
--- a/src/ibushotkey.h
+++ b/src/ibushotkey.h
@ -1,8 +1,8 @@
 /* -*- mode: C; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
 /* vim:set et sts=4: */
 /* IBus - The Input Bus
- * Copyright (C) 2008-2010 Peng Huang <shawn.p.huang@gmail.com>
- * Copyright (C) 2008-2010 Red Hat, Inc.
+ * Copyright (C) 2008-2013 Peng Huang <shawn.p.huang@gmail.com>
+ * Copyright (C) 2008-2013 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
@ -24,6 +24,9 @@
 #error "Only <ibus.h> can be included directly"
 #endif

+#ifndef __IBUS_HOTKEY_H_
+#define __IBUS_HOTKEY_H_
+
 /**
 * SECTION: ibushotkey
 * @short_description: Hotkeys and associated events.
@ -31,8 +34,6 @@
 *
 * An IBusHotkeyProfile associates a hotkey and an event.
 */
-#ifndef __IBUS_HOTKEY_H_
-#define __IBUS_HOTKEY_H_

 #include "ibusserializable.h"

--- a/src/ibusinputcontext.c
+++ b/src/ibusinputcontext.c
@ -250,6 +250,8 @@ ibus_input_context_class_init (IBusInputContextClass *class)
    /**
     * IBusInputContext::update-auxiliary-text:
     * @context: An IBusInputContext.
+     * @text: An auxiliary text
+     * @visible: The visibility of @text
     *
     * Emitted to hide auxilary text.
     *
--- a/src/ibuskeymap.h
+++ b/src/ibuskeymap.h
@ -24,6 +24,9 @@
 #error "Only <ibus.h> can be included directly"
 #endif

+#ifndef __IBUS_KEYMAP_H_
+#define __IBUS_KEYMAP_H_
+
 /**
 * SECTION: ibuskeymap
 * @short_description: Keyboard mapping handling.
@ -41,13 +44,10 @@
 * Then ibus_keymap_lookup_keysym() can
 * convert scancodes back to the key symbols.
 *
- * @see_also: #IBusComponent, #IBusEngineDesc
+ * see_also: #IBusComponent, #IBusEngineDesc
 *
 */

-#ifndef __IBUS_KEYMAP_H_
-#define __IBUS_KEYMAP_H_
-
 #include "ibusobject.h"

 /*
@ -129,7 +129,8 @@ IBusKeymap        *ibus_keymap_new                  (const gchar        *name)
 /**
 * ibus_keymap_get:
 * @name: The keymap file to be loaded, such as 'us', 'jp'.
- * @returns: An IBusKeymap associated with the giving name; or NULL if failed.
+ * @returns: (transfer full): An IBusKeymap associated with the giving name;
+ * or %NULL if failed.
 *
 * Get an IBusKeymap associated with the giving name.
 *
--- a/src/ibuskeysyms-compat.h
+++ b/src/ibuskeysyms-compat.h
@ -1,7 +1,7 @@
 /* -*- mode: C; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
 /* ibus - The Input Bus
- * Copyright (C) 2008-2010 Peng Huang <shawn.p.huang@gmail.com>
- * Copyright (C) 2008-2010 Red Hat, Inc.
+ * Copyright (C) 2008-2013 Peng Huang <shawn.p.huang@gmail.com>
+ * Copyright (C) 2008-2013 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
@ -23,6 +23,9 @@
 #error "Only <ibus.h> can be included directly"
 #endif

+#ifndef __IBUS_KEYSYMS_COMPAT_H__
+#define __IBUS_KEYSYMS_COMPAT_H__
+
 /**
 * SECTION: ibuskeysyms
 * @short_description: Key symbol definition.
@ -36,13 +39,10 @@
 * Most of the key symbols are not explicit documented,
 * because they are self-explaining.
 *
- * @see_also: #IBusKeymap, #IBusHotkeyProfile
+ * see_also: #IBusKeymap, #IBusHotkeyProfile
 *
 */

-#ifndef __IBUS_KEYSYMS_COMPAT_H__
-#define __IBUS_KEYSYMS_COMPAT_H__
-

 #define IBUS_VoidSymbol 0xffffff
 #define IBUS_BackSpace 0xff08
--- a/src/ibuskeyuni.c
+++ b/src/ibuskeyuni.c
@ -861,16 +861,6 @@ static const struct {
  { 0xFFFF /* Delete */, '\177' }
 };

-/**
- * ibus_keyval_to_unicode:
- * @keyval: an IBus key symbol 
- * 
- * Convert from an IBus key symbol to the corresponding ISO10646 (Unicode)
- * character.
- * 
- * Return value: the corresponding unicode character, or 0 if there
- *               is no corresponding character.
- **/
 gunichar
 ibus_keyval_to_unicode (guint keyval)
 {
@ -1661,16 +1651,6 @@ static const struct {
  { 0x0ef7, 0x318e }, /*               Hangul_AraeAE ㆎ HANGUL LETTER ARAEAE */
 };

-/**
- * ibus_unicode_to_keyval:
- * @wc: a ISO10646 encoded character
- * 
- * Convert from a ISO10646 character to a key symbol.
- * 
- * Return value: the corresponding IBus key symbol, if one exists.
- *               or, if there is no corresponding symbol, 
- *               wc | 0x01000000
- **/
 guint
 ibus_unicode_to_keyval (gunichar wc)
 {
--- a/src/ibuslookuptable.h
+++ b/src/ibuslookuptable.h
@ -1,8 +1,8 @@
 /* -*- mode: C; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
 /* vim:set et sts=4: */
 /* IBus - The Input Bus
- * Copyright (C) 2008-2010 Peng Huang <shawn.p.huang@gmail.com>
- * Copyright (C) 2008-2010 Red Hat, Inc.
+ * Copyright (C) 2008-2013 Peng Huang <shawn.p.huang@gmail.com>
+ * Copyright (C) 2008-2013 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
@ -24,20 +24,23 @@
 #error "Only <ibus.h> can be included directly"
 #endif

+#ifndef __IBUS_LOOKUP_TABLE_H_
+#define __IBUS_LOOKUP_TABLE_H_
+
 /**
 * SECTION: ibuslookuptable
 * @short_description: Candidate word/phrase lookup table.
 * @stability: Stable
- * @see_also: #IBusEngine
 *
- * An IBusLookuptable stores the candidate words or phrases for users to choose from.
+ * An IBusLookuptable stores the candidate words or phrases for users to
+ * choose from.
 *
 * Use ibus_engine_update_lookup_table(), ibus_engine_show_lookup_table(),
 * and ibus_engine_hide_lookup_table() to update, show and hide the lookup
 * table.
+ *
+ * see_also: #IBusEngine
 */
-#ifndef __IBUS_LOOKUP_TABLE_H_
-#define __IBUS_LOOKUP_TABLE_H_

 #include "ibusserializable.h"
 #include "ibustext.h"
--- a/src/ibusobject.c
+++ b/src/ibusobject.c
@ -1,8 +1,8 @@
 /* -*- mode: C; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
 /* vim:set et sts=4: */
 /* ibus - The Input Bus
- * Copyright (C) 2008-2010 Peng Huang <shawn.p.huang@gmail.com>
- * Copyright (C) 2008-2010 Red Hat, Inc.
+ * Copyright (C) 2008-2013 Peng Huang <shawn.p.huang@gmail.com>
+ * Copyright (C) 2008-2013 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
@ -162,13 +162,6 @@ ibus_object_real_destroy (IBusObject *obj)
    g_signal_handlers_destroy (obj);
 }

-/**
- * ibus_object_new:
- *
- * Creates a new instance of an #IBusObject.
- *
- * Returns: a new instance of #IBusObject.
- */
 IBusObject *
 ibus_object_new (void)
 {
--- a/src/ibusobject.h
+++ b/src/ibusobject.h
@ -1,8 +1,8 @@
 /* -*- mode: C; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
 /* vim:set et sts=4: */
 /* ibus - The Input Bus
- * Copyright (C) 2008-2010 Peng Huang <shawn.p.huang@gmail.com>
- * Copyright (C) 2008-2010 Red Hat, Inc.
+ * Copyright (C) 2008-2013 Peng Huang <shawn.p.huang@gmail.com>
+ * Copyright (C) 2008-2013 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
@ -24,6 +24,9 @@
 #error "Only <ibus.h> can be included directly"
 #endif

+#ifndef __IBUS_OBJECT_H_
+#define __IBUS_OBJECT_H_
+
 /**
 * SECTION: ibusobject
 * @short_description: Base object of IBus.
@ -32,8 +35,6 @@
 *
 * IBusObject is the base object for all objects in IBus.
 */
-#ifndef __IBUS_OBJECT_H_
-#define __IBUS_OBJECT_H_

 #include <glib-object.h>
 #include "ibustypes.h"
@ -90,7 +91,7 @@ struct _IBusObject {
    IBusObjectPrivate *priv;
 };

-typedef void ( *IBusObjectDestroyFunc) (IBusObject *);
+typedef void ( *IBusObjectDestroyFunc) (IBusObject *object);

 struct _IBusObjectClass {
    GInitiallyUnownedClass parent;
--- a/src/ibusobservedpath.h
+++ b/src/ibusobservedpath.h
@ -1,8 +1,8 @@
 /* -*- mode: C; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
 /* vim:set et sts=4: */
 /* ibus - The Input IBus
- * Copyright (C) 2008-2010 Peng Huang <shawn.p.huang@gmail.com>
- * Copyright (C) 2008-2010 Red Hat, Inc.
+ * Copyright (C) 2008-2013 Peng Huang <shawn.p.huang@gmail.com>
+ * Copyright (C) 2008-2013 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
@ -24,6 +24,9 @@
 #error "Only <ibus.h> can be included directly"
 #endif

+#ifndef __IBUS_OBSERVED_PATH_H_
+#define __IBUS_OBSERVED_PATH_H_
+
 /**
 * SECTION: ibusobservedpath
 * @short_description: Path object of IBus.
@ -33,9 +36,6 @@
 * such as monitor modification, directory tree traversal.
 */

-#ifndef __IBUS_OBSERVED_PATH_H_
-#define __IBUS_OBSERVED_PATH_H_
-
 #include "ibusserializable.h"
 #include "ibusxml.h"

@ -117,9 +117,11 @@ IBusObservedPath    *ibus_observed_path_new                 (const gchar
 * ibus_observed_path_traverse:
 * @path: An IBusObservedPath.
 * @dir_only: Only looks for subdirs, not files
- * @returns: (element-type IBusObservedPath): A newly allocate GList which holds content in path; NULL if @path is not directory.
+ * @returns: (transfer full) (element-type IBusObservedPath): A newly allocate
+ * GList which holds content in path; NULL if @path is not directory.
 *
- * Recursively traverse the path and put the files and subdirectory in to a newly allocated
+ * Recursively traverse the path and put the files and subdirectory in to
+ * a newly allocated
 * GLists, if the @path is a directory. Otherwise returns NULL.
 */
 GList               *ibus_observed_path_traverse            (IBusObservedPath   *path,
--- a/src/ibuspanelservice.c
+++ b/src/ibuspanelservice.c
@ -266,6 +266,7 @@ ibus_panel_service_class_init (IBusPanelServiceClass *class)
    /* install signals */
    /**
     * IBusPanelService::update-preedit-text:
+     * @panel: An #IBusPanelService
     * @text: A preedit text to be updated.
     * @cursor_pos: The cursor position of the text.
     * @visible: Whether the update is visible.
@ -292,6 +293,7 @@ ibus_panel_service_class_init (IBusPanelServiceClass *class)

    /**
     * IBusPanelService::update-auxiliary-text:
+     * @panel: An #IBusPanelService
     * @text: A preedit text to be updated.
     * @visible: Whether the update is visible.
     *
@ -316,6 +318,7 @@ ibus_panel_service_class_init (IBusPanelServiceClass *class)

    /**
     * IBusPanelService::update-lookup-table:
+     * @panel: An #IBusPanelService
     * @lookup_table: A lookup table to be updated.
     * @visible: Whether the update is visible.
     *
@ -340,6 +343,7 @@ ibus_panel_service_class_init (IBusPanelServiceClass *class)

    /**
     * IBusPanelService::focus-in:
+     * @panel: An #IBusPanelService
     * @input_context_path: Object path of InputContext.
     *
     * Emitted when the client application get the focus-in.
@ -362,6 +366,7 @@ ibus_panel_service_class_init (IBusPanelServiceClass *class)

    /**
     * IBusPanelService::focus-out:
+     * @panel: An #IBusPanelService
     * @input_context_path: Object path of InputContext.
     *
     * Emitted when the client application get the focus-out.
@ -384,6 +389,7 @@ ibus_panel_service_class_init (IBusPanelServiceClass *class)

    /**
     * IBusPanelService::register-properties:
+     * @panel: An #IBusPanelService
     * @prop_list: An IBusPropList that contains properties.
     *
     * Emitted when the client application get the register-properties.
@ -406,6 +412,7 @@ ibus_panel_service_class_init (IBusPanelServiceClass *class)

    /**
     * IBusPanelService::update-property:
+     * @panel: An #IBusPanelService
     * @prop: The IBusProperty to be updated.
     *
     * Emitted when the client application get the update-property.
@ -428,6 +435,7 @@ ibus_panel_service_class_init (IBusPanelServiceClass *class)

    /**
     * IBusPanelService::set-cursor-location:
+     * @panel: An #IBusPanelService
     * @x: X coordinate of the cursor.
     * @y: Y coordinate of the cursor.
     * @w: Width of the cursor.
@ -456,6 +464,7 @@ ibus_panel_service_class_init (IBusPanelServiceClass *class)

    /**
     * IBusPanelService::cursor-up-lookup-table:
+     * @panel: An #IBusPanelService
     *
     * Emitted when the client application get the cursor-up-lookup-table.
     * Implement the member function cursor_up_lookup_table() in extended
@ -475,6 +484,7 @@ ibus_panel_service_class_init (IBusPanelServiceClass *class)

    /**
     * IBusPanelService::cursor-down-lookup-table:
+     * @panel: An #IBusPanelService
     *
     * Emitted when the client application get the cursor-down-lookup-table.
     * Implement the member function cursor_down_lookup_table() in extended
@ -494,6 +504,7 @@ ibus_panel_service_class_init (IBusPanelServiceClass *class)

    /**
     * IBusPanelService::hide-auxiliary-text:
+     * @panel: An #IBusPanelService
     *
     * Emitted when the client application get the hide-auxiliary-text.
     * Implement the member function hide_auxiliary_text() in extended class
@ -513,6 +524,7 @@ ibus_panel_service_class_init (IBusPanelServiceClass *class)

    /**
     * IBusPanelService::hide-language-bar:
+     * @panel: An #IBusPanelService
     *
     * Emitted when the client application get the hide-language-bar.
     * Implement the member function hide_language_bar() in extended class to
@ -532,6 +544,7 @@ ibus_panel_service_class_init (IBusPanelServiceClass *class)

    /**
     * IBusPanelService::hide-lookup-table:
+     * @panel: An #IBusPanelService
     *
     * Emitted when the client application get the hide-lookup-table.
     * Implement the member function hide_lookup_table() in extended class to
@ -551,6 +564,7 @@ ibus_panel_service_class_init (IBusPanelServiceClass *class)

    /**
     * IBusPanelService::hide-preedit-text:
+     * @panel: An #IBusPanelService
     *
     * Emitted when the client application get the hide-preedit-text.
     * Implement the member function hide_preedit_text() in extended class to
@ -570,6 +584,7 @@ ibus_panel_service_class_init (IBusPanelServiceClass *class)

    /**
     * IBusPanelService::page-up-lookup-table:
+     * @panel: An #IBusPanelService
     *
     * Emitted when the client application get the page-up-lookup-table.
     * Implement the member function page_up_lookup_table() in extended class
@ -589,6 +604,7 @@ ibus_panel_service_class_init (IBusPanelServiceClass *class)

    /**
     * IBusPanelService::page-down-lookup-table:
+     * @panel: An #IBusPanelService
     *
     * Emitted when the client application get the page-down-lookup-table.
     * Implement the member function page_down_lookup_table() in extended
@ -608,6 +624,7 @@ ibus_panel_service_class_init (IBusPanelServiceClass *class)

    /**
     * IBusPanelService::reset:
+     * @panel: An #IBusPanelService
     *
     * Emitted when the client application get the reset.
     * Implement the member function reset() in extended class to receive this
@ -627,6 +644,7 @@ ibus_panel_service_class_init (IBusPanelServiceClass *class)

    /**
     * IBusPanelService::show-auxiliary-text:
+     * @panel: An #IBusPanelService
     *
     * Emitted when the client application get the show-auxiliary-text.
     * Implement the member function show_auxiliary_text() in extended class
@ -646,6 +664,7 @@ ibus_panel_service_class_init (IBusPanelServiceClass *class)

    /**
     * IBusPanelService::show-language-bar:
+     * @panel: An #IBusPanelService
     *
     * Emitted when the client application get the show-language-bar.
     * Implement the member function show_language_bar() in extended class to
@ -665,6 +684,7 @@ ibus_panel_service_class_init (IBusPanelServiceClass *class)

    /**
     * IBusPanelService::show-lookup-table:
+     * @panel: An #IBusPanelService
     *
     * Emitted when the client application get the show-lookup-table.
     * Implement the member function show_lookup_table() in extended class to
@ -684,6 +704,7 @@ ibus_panel_service_class_init (IBusPanelServiceClass *class)

    /**
     * IBusPanelService::show-preedit-text:
+     * @panel: An #IBusPanelService
     *
     * Emitted when the client application get the show-preedit-text.
     * Implement the member function show_preedit_text() in extended class to
@ -703,6 +724,7 @@ ibus_panel_service_class_init (IBusPanelServiceClass *class)

    /**
     * IBusPanelService::start-setup:
+     * @panel: An #IBusPanelService
     *
     * Emitted when the client application get the start-setup.
     * Implement the member function start_setup() in extended class to
@ -722,6 +744,7 @@ ibus_panel_service_class_init (IBusPanelServiceClass *class)

    /**
     * IBusPanelService::state-changed:
+     * @panel: An #IBusPanelService
     *
     * Emitted when the client application get the state-changed.
     * Implement the member function state_changed() in extended class to
@ -741,6 +764,7 @@ ibus_panel_service_class_init (IBusPanelServiceClass *class)

    /**
     * IBusPanelService::destroy-context:
+     * @panel: An #IBusPanelService
     * @input_context_path: Object path of InputContext.
     *
     * Emitted when the client application destroys.
--- a/src/ibusproplist.h
+++ b/src/ibusproplist.h
@ -1,8 +1,8 @@
 /* -*- mode: C; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
 /* vim:set et sts=4: */
 /* IBus - The Input Bus
- * Copyright (C) 2008-2010 Peng Huang <shawn.p.huang@gmail.com>
- * Copyright (C) 2008-2010 Red Hat, Inc.
+ * Copyright (C) 2008-2013 Peng Huang <shawn.p.huang@gmail.com>
+ * Copyright (C) 2008-2013 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
@ -24,17 +24,18 @@
 #error "Only <ibus.h> can be included directly"
 #endif

+#ifndef __IBUS_PROP_LIST_H_
+#define __IBUS_PROP_LIST_H_
+
 /**
 * SECTION: ibusproplist
 * @Title: IBusPropList
 * @Short_description: An #IBusProperty container.
 * @Stability: Stable
 *
- * @See_also: #IBusProperty, #IBusEngine
+ * See_also: #IBusProperty, #IBusEngine
 *
 */
-#ifndef __IBUS_PROP_LIST_H_
-#define __IBUS_PROP_LIST_H_

 #include "ibusserializable.h"
 #include "ibusproperty.h"
--- a/src/ibusproxy.h
+++ b/src/ibusproxy.h
@ -1,8 +1,8 @@
 /* -*- mode: C; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
 /* vim:set et sts=4: */
 /* ibus - The Input Bus
- * Copyright (C) 2008-2010 Peng Huang <shawn.p.huang@gmail.com>
- * Copyright (C) 2008-2010 Red Hat, Inc.
+ * Copyright (C) 2008-2013 Peng Huang <shawn.p.huang@gmail.com>
+ * Copyright (C) 2008-2013 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
@ -24,20 +24,24 @@
 #error "Only <ibus.h> can be included directly"
 #endif

+#ifndef __IBUS_PROXY_H_
+#define __IBUS_PROXY_H_
+
 /**
 * SECTION: ibusproxy
 * @short_description: Base proxy object.
 * @stability: Stable
 *
 * An IBusProxy is the base of all proxy objects,
- * which communicate the corresponding #IBusServices on the other end of IBusConnection.
- * For example, IBus clients (such as editors, web browsers) invoke the proxy object,
- * IBusInputContext to communicate with the InputContext service of the ibus-daemon.
+ * which communicate the corresponding #IBusServices on the other end of
+ * IBusConnection.
+ * For example, IBus clients (such as editors, web browsers) invoke the proxy
+ * object,
+ * IBusInputContext to communicate with the InputContext service of the
+ * ibus-daemon.
 *
 * Almost all services have corresponding proxies, except very simple services.
 */
-#ifndef __IBUS_PROXY_H_
-#define __IBUS_PROXY_H_

 #include <gio/gio.h>

--- a/src/ibusserializable.h
+++ b/src/ibusserializable.h
@ -1,8 +1,8 @@
 /* -*- mode: C; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
 /* vim:set et sts=4: */
 /* ibus - The Input Bus
- * Copyright (C) 2008-2010 Peng Huang <shawn.p.huang@gmail.com>
- * Copyright (C) 2008-2010 Red Hat, Inc.
+ * Copyright (C) 2008-2013 Peng Huang <shawn.p.huang@gmail.com>
+ * Copyright (C) 2008-2013 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
@ -24,6 +24,9 @@
 #error "Only <ibus.h> can be included directly"
 #endif

+#ifndef __IBUS_SERIALIZABLE_H_
+#define __IBUS_SERIALIZABLE_H_
+
 /**
 * SECTION: ibusserializable
 * @short_description: A serializable object.
@ -48,8 +51,6 @@
 * See IBusSerializableSerializeFunc(), IBusSerializableDeserializeFunc(), IBusSerializableCopyFunc()
 * for function prototype.
 */
-#ifndef __IBUS_SERIALIZABLE_H_
-#define __IBUS_SERIALIZABLE_H_

 #include "ibusobject.h"

--- a/src/ibusservice.h
+++ b/src/ibusservice.h
@ -1,8 +1,8 @@
 /* -*- mode: C; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
 /* vim:set et sts=4: */
 /* ibus - The Input Bus
- * Copyright (C) 2008-2010 Peng Huang <shawn.p.huang@gmail.com>
- * Copyright (C) 2008-2010 Red Hat, Inc.
+ * Copyright (C) 2008-2013 Peng Huang <shawn.p.huang@gmail.com>
+ * Copyright (C) 2008-2013 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
@ -24,6 +24,9 @@
 #error "Only <ibus.h> can be included directly"
 #endif

+#ifndef __IBUS_SERVICE_H_
+#define __IBUS_SERVICE_H_
+
 /**
 * SECTION: ibusservice
 * @short_description: IBus service back-end.
@ -32,9 +35,6 @@
 * An IBusService is a base class for services.
 */

-#ifndef __IBUS_SERVICE_H_
-#define __IBUS_SERVICE_H_
-
 #include <gio/gio.h>
 #include "ibusobject.h"

@ -178,7 +178,7 @@ void             ibus_service_unregister        (IBusService        *service,
 *
 * Send signal to all the IBusConnections of an IBusService.
 *
- * @see_also: g_dbus_connection_emit_signal()
+ * see_also: g_dbus_connection_emit_signal()
 */
 gboolean         ibus_service_emit_signal       (IBusService        *service,
                                                 const gchar        *dest_bus_name,
--- a/src/ibusshare.h
+++ b/src/ibusshare.h
@ -1,8 +1,8 @@
 /* -*- mode: C; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
 /* vim:set et sts=4: */
 /* ibus - The Input Bus
- * Copyright (C) 2008-2010 Peng Huang <shawn.p.huang@gmail.com>
- * Copyright (C) 2008-2010 Red Hat, Inc.
+ * Copyright (C) 2008-2013 Peng Huang <shawn.p.huang@gmail.com>
+ * Copyright (C) 2008-2013 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
@ -24,6 +24,9 @@
 #error "Only <ibus.h> can be included directly"
 #endif

+#ifndef __IBUS_SHARE_H_
+#define __IBUS_SHARE_H_
+
 /**
 * SECTION: ibusshare
 * @short_description: Shared utility functions and definition.
@ -33,9 +36,6 @@
 * which are shared among ibus component and services.
 */

-#ifndef __IBUS_SHARE_H_
-#define __IBUS_SHARE_H_
-
 #include <glib.h>

 #ifdef IBUS_DISABLE_DEPRECATION_WARNINGS
--- a/src/ibustext.h
+++ b/src/ibustext.h
@ -1,8 +1,8 @@
 /* -*- mode: C; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
 /* vim:set et sts=4: */
 /* IBus - The Input Bus
- * Copyright (C) 2008-2010 Peng Huang <shawn.p.huang@gmail.com>
- * Copyright (C) 2008-2010 Red Hat, Inc.
+ * Copyright (C) 2008-2013 Peng Huang <shawn.p.huang@gmail.com>
+ * Copyright (C) 2008-2013 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
@ -24,20 +24,21 @@
 #error "Only <ibus.h> can be included directly"
 #endif

+#ifndef __IBUS_TEXT_H_
+#define __IBUS_TEXT_H_
+
 /**
 * SECTION: ibustext
 * @short_description: Text with decorating information.
- * @see_also: #IBusAttribute
 *
 * An IBusText is the main text object in IBus.
 * The text is decorated according to associated IBusAttribute,
 * e.g. the foreground/background color, underline, and
 * applied scope.
+ *
+ * see_also: #IBusAttribute
 */

-#ifndef __IBUS_TEXT_H_
-#define __IBUS_TEXT_H_
-
 #include "ibusserializable.h"
 #include "ibusattrlist.h"

--- a/src/ibustypes.h
+++ b/src/ibustypes.h
@ -24,16 +24,18 @@
 #error "Only <ibus.h> can be included directly"
 #endif

+#ifndef __IBUS_TYPES_H_
+#define __IBUS_TYPES_H_
+
 /**
 * SECTION: ibustypes
 * @short_description: Generic types for  IBus.
 * @stability: Stable
 *
- * This section consists generic types for IBus, including shift/control key modifiers,
+ * This section consists generic types for IBus, including shift/control key
+ * modifiers,
 * and a rectangle structure.
 */
-#ifndef __IBUS_TYPES_H_
-#define __IBUS_TYPES_H_

 /**
 * IBusModifierType:
--- a/src/ibusutil.h
+++ b/src/ibusutil.h
@ -1,9 +1,9 @@
 /* -*- mode: C; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
 /* vim:set et sts=4: */
 /* bus - The Input Bus
- * Copyright (C) 2008-2011 Peng Huang <shawn.p.huang@gmail.com>
- * Copyright (C) 2010-2011 Takao Fujiwara <takao.fujiwara1@gmail.com>
- * Copyright (C) 2008-2011 Red Hat, Inc.
+ * Copyright (C) 2008-2013 Peng Huang <shawn.p.huang@gmail.com>
+ * Copyright (C) 2010-2013 Takao Fujiwara <takao.fujiwara1@gmail.com>
+ * Copyright (C) 2008-2013 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
@ -25,6 +25,9 @@
 #error "Only <ibus.h> can be included directly"
 #endif

+#ifndef __IBUS_UTIL_H_
+#define __IBUS_UTIL_H_
+
 /**
 * SECTION: ibusutil
 * @short_description: Utilities with C-Language.
@ -33,9 +36,6 @@
 * Utilized functions are available for miscellaneous purposes.
 */

-#ifndef __IBUS_UTIL_H_
-#define __IBUS_UTIL_H_
-
 /**
 * ibus_get_language_name:
 * @_locale: A const locale name.
--- a/src/ibusversion.h.in
+++ b/src/ibusversion.h.in
@ -18,6 +18,10 @@
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
 * USA
 */
+
+#ifndef __IBUS_VERSION_H_
+#define __IBUS_VERSION_H_
+
 /**
 * SECTION: ibusversion
 * @short_description: Current version of IBus.
@ -26,8 +30,6 @@
 * IBusVersion shows the current IBus version.
 */

-#ifndef __IBUS_VERSION_H_
-#define __IBUS_VERSION_H_
 /* compile time version
 */
 /**
--- a/src/ibusxml.h
+++ b/src/ibusxml.h
@ -1,8 +1,8 @@
 /* -*- mode: C; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
 /* vim:set et sts=4: */
 /* bus - The Input Bus
- * Copyright (C) 2008-2010 Peng Huang <shawn.p.huang@gmail.com>
- * Copyright (C) 2008-2010 Red Hat, Inc.
+ * Copyright (C) 2008-2013 Peng Huang <shawn.p.huang@gmail.com>
+ * Copyright (C) 2008-2013 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
@ -24,6 +24,9 @@
 #error "Only <ibus.h> can be included directly"
 #endif

+#ifndef __IBUS_XML_H__
+#define __IBUS_XML_H__
+
 /**
 * SECTION: ibusxml
 * @short_description: XML handling functions for IBus.
@ -31,8 +34,6 @@
 *
 * IBusXML lists data structure and handling function for XML in IBus.
 */
-#ifndef __IBUS_XML_H__
-#define __IBUS_XML_H__

 #include <glib.h>