ayatana-commits team mailing list archive
-
ayatana-commits team
-
Mailing list archive
-
Message #03189
[Branch ~dbusmenu-team/dbusmenu/trunk] Rev 229: Documentation fixes
------------------------------------------------------------
revno: 229
committer: Ted Gould <ted@xxxxxxxx>
branch nick: trunk
timestamp: Thu 2011-02-24 09:38:18 -0600
message:
Documentation fixes
modified:
docs/libdbusmenu-glib/reference/Makefile.am
docs/libdbusmenu-glib/reference/libdbusmenu-glib-docs.sgml
docs/libdbusmenu-glib/reference/libdbusmenu-glib-sections.txt
libdbusmenu-glib/client.h
libdbusmenu-glib/defaults.c
libdbusmenu-glib/defaults.h
libdbusmenu-glib/enum-types.h.in
libdbusmenu-glib/server.c
libdbusmenu-glib/server.h
libdbusmenu-glib/types.h
--
lp:dbusmenu
https://code.launchpad.net/~dbusmenu-team/dbusmenu/trunk
Your team ayatana-commits is subscribed to branch lp:dbusmenu.
To unsubscribe from this branch go to https://code.launchpad.net/~dbusmenu-team/dbusmenu/trunk/+edit-subscription
=== modified file 'docs/libdbusmenu-glib/reference/Makefile.am'
--- docs/libdbusmenu-glib/reference/Makefile.am 2011-02-21 21:11:49 +0000
+++ docs/libdbusmenu-glib/reference/Makefile.am 2011-02-24 15:38:18 +0000
@@ -51,6 +51,7 @@
dbus-menu-clean.xml.h \
client-menuitem.h \
client-private.h \
+ defaults.h \
menuitem-marshal.h \
server-marshal.h \
menuitem-private.h
=== modified file 'docs/libdbusmenu-glib/reference/libdbusmenu-glib-docs.sgml'
--- docs/libdbusmenu-glib/reference/libdbusmenu-glib-docs.sgml 2011-02-21 20:09:33 +0000
+++ docs/libdbusmenu-glib/reference/libdbusmenu-glib-docs.sgml 2011-02-24 15:38:18 +0000
@@ -18,6 +18,7 @@
<xi:include href="xml/client-menuitem.xml"/>
<xi:include href="xml/dbusmenu-client.xml"/>
<xi:include href="xml/dbusmenu-server.xml"/>
+ <xi:include href="xml/types.xml"/>
</chapter>
<chapter id="object-tree">
=== modified file 'docs/libdbusmenu-glib/reference/libdbusmenu-glib-sections.txt'
--- docs/libdbusmenu-glib/reference/libdbusmenu-glib-sections.txt 2011-02-21 20:05:19 +0000
+++ docs/libdbusmenu-glib/reference/libdbusmenu-glib-sections.txt 2011-02-24 15:38:18 +0000
@@ -6,8 +6,11 @@
DBUSMENU_CLIENT_SIGNAL_NEW_MENUITEM
DBUSMENU_CLIENT_SIGNAL_EVENT_RESULT
DBUSMENU_CLIENT_SIGNAL_ITEM_ACTIVATE
+DBUSMENU_CLIENT_SIGNAL_TEXT_DIRECTION_CHANGED
DBUSMENU_CLIENT_PROP_DBUS_NAME
DBUSMENU_CLIENT_PROP_DBUS_OBJECT
+DBUSMENU_CLIENT_PROP_STATUS
+DBUSMENU_CLIENT_PROP_TEXT_DIRECTION
DBUSMENU_CLIENT_TYPES_DEFAULT
DBUSMENU_CLIENT_TYPES_SEPARATOR
DBUSMENU_CLIENT_TYPES_IMAGE
@@ -17,6 +20,8 @@
DbusmenuClientTypeDestroyHandler
dbusmenu_client_new
dbusmenu_client_get_root
+dbusmenu_client_get_status
+dbusmenu_client_get_text_direction
dbusmenu_client_add_type_handler
dbusmenu_client_add_type_handler_full
<SUBSECTION Standard>
@@ -122,11 +127,17 @@
DBUSMENU_SERVER_SIGNAL_ITEM_ACTIVATION
DBUSMENU_SERVER_PROP_DBUS_OBJECT
DBUSMENU_SERVER_PROP_ROOT_NODE
+DBUSMENU_SERVER_PROP_STATUS
+DBUSMENU_SERVER_PROP_TEXT_DIRECTION
DBUSMENU_SERVER_PROP_VERSION
DbusmenuServer
DbusmenuServerClass
dbusmenu_server_new
+dbusmenu_server_get_status
+dbusmenu_server_get_text_direction
dbusmenu_server_set_root
+dbusmenu_server_set_status
+dbusmenu_server_set_text_direction
<SUBSECTION Standard>
DBUSMENU_SERVER
DBUSMENU_IS_SERVER
@@ -158,3 +169,21 @@
dbusmenu_menuitem_proxy_get_type
</SECTION>
+<SECTION>
+<FILE>types</FILE>
+<TITLE>Types</TITLE>
+DBUSMENU_TYPE_STATUS
+DBUSMENU_TYPE_TEXT_DIRECTION
+DbusmenuStatus
+DbusmenuTextDirection
+dbusmenu_status_get_nick
+dbusmenu_status_get_type
+dbusmenu_status_get_value_from_nick
+dbusmenu_text_direction_get_nick
+dbusmenu_text_direction_get_type
+dbusmenu_text_direction_get_value_from_nick
+<SUBSECTION Private>
+DbusmenuServerPrivate
+dbusmenu_server_get_type
+</SECTION>
+
=== modified file 'libdbusmenu-glib/client.h'
--- libdbusmenu-glib/client.h 2011-02-24 14:33:06 +0000
+++ libdbusmenu-glib/client.h 2011-02-24 15:38:18 +0000
@@ -74,6 +74,11 @@
* String to attach to signal #DbusmenuClient::event-result
*/
#define DBUSMENU_CLIENT_SIGNAL_EVENT_RESULT "event-result"
+/**
+ * DBUSMENU_CLIENT_SIGNAL_TEXT_DIRECTION_CHANGED:
+ *
+ * String to attach to signal #DbusmenuClient::text-direction-changed
+ */
#define DBUSMENU_CLIENT_SIGNAL_TEXT_DIRECTION_CHANGED "text-direction-changed"
/**
@@ -88,7 +93,17 @@
* String to access property #DbusmenuClient:dbus-object
*/
#define DBUSMENU_CLIENT_PROP_DBUS_OBJECT "dbus-object"
+/**
+ * DBUSMENU_CLIENT_PROP_STATUS:
+ *
+ * String to access property #DbusmenuClient:status
+ */
#define DBUSMENU_CLIENT_PROP_STATUS "status"
+/**
+ * DBUSMENU_CLIENT_PROP_TEXT_DIRECTION:
+ *
+ * String to access property #DbusmenuClient:text-direction
+ */
#define DBUSMENU_CLIENT_PROP_TEXT_DIRECTION "text-direction"
/**
=== modified file 'libdbusmenu-glib/defaults.c'
--- libdbusmenu-glib/defaults.c 2011-02-22 03:51:35 +0000
+++ libdbusmenu-glib/defaults.c 2011-02-24 15:38:18 +0000
@@ -156,7 +156,7 @@
static DbusmenuDefaults * default_defaults = NULL;
-/**
+/*
* dbusmenu_defaults_ref_default:
*
* Get a reference to the default instance. If it doesn't exist this
@@ -177,7 +177,7 @@
return default_defaults;
}
-/**
+/*
* dbusmenu_defaults_default_set:
* @defaults: The #DbusmenuDefaults object to add to
* @type: (allow-none): The #DbusmenuMenuitem type for this default if #NULL will default to #DBUSMENU_CLIENT_TYPE_DEFAULT
@@ -216,7 +216,7 @@
return;
}
-/**
+/*
* dbusmenu_defaults_default_get:
* @defaults: The default database to use
* @type: (allow-none): The #DbusmenuMenuitem type for this default if #NULL will default to #DBUSMENU_CLIENT_TYPE_DEFAULT
@@ -253,7 +253,7 @@
return entry->value;
}
-/**
+/*
* dbusmenu_defaults_default_get_type:
* @defaults: The default database to use
* @type: (allow-none): The #DbusmenuMenuitem type for this default if #NULL will default to #DBUSMENU_CLIENT_TYPE_DEFAULT
=== modified file 'libdbusmenu-glib/defaults.h'
--- libdbusmenu-glib/defaults.h 2011-02-21 23:29:13 +0000
+++ libdbusmenu-glib/defaults.h 2011-02-24 15:38:18 +0000
@@ -45,7 +45,7 @@
typedef struct _DbusmenuDefaultsClass DbusmenuDefaultsClass;
typedef struct _DbusmenuDefaultsPrivate DbusmenuDefaultsPrivate;
-/**
+/*
* DbusmenuDefaultsClass:
*
* All of the signals and functions for #DbusmenuDefaults
@@ -54,7 +54,7 @@
GObjectClass parent_class;
};
-/**
+/*
* DbusmenuDefaults:
*
* A singleton to hold all of the defaults for the menuitems
=== modified file 'libdbusmenu-glib/enum-types.h.in'
--- libdbusmenu-glib/enum-types.h.in 2011-02-18 18:48:23 +0000
+++ libdbusmenu-glib/enum-types.h.in 2011-02-24 15:38:18 +0000
@@ -51,6 +51,12 @@
GType @enum_name@_get_type (void) G_GNUC_CONST;
const gchar * @enum_name@_get_nick (@EnumName@ value) G_GNUC_CONST;
@EnumName@ @enum_name@_get_value_from_nick (const gchar * nick) G_GNUC_CONST;
+/**
+ DBUSMENU_TYPE_@ENUMSHORT@:
+
+ Gets the #GType value for the type associated with the
+ #@EnumName@ enumerated type.
+*/
#define DBUSMENU_TYPE_@ENUMSHORT@ (@enum_name@_get_type())
/*** END value-header ***/
=== modified file 'libdbusmenu-glib/server.c'
--- libdbusmenu-glib/server.c 2011-02-24 14:34:48 +0000
+++ libdbusmenu-glib/server.c 2011-02-24 15:38:18 +0000
@@ -1635,6 +1635,7 @@
/**
dbusmenu_server_set_text_direction:
@server: The #DbusmenuServer object to set the text direction on
+ @dir: Direction of the text
Sets the text direction that should be exported over DBus for
this server. If the value is set to #DBUSMENU_TEXT_DIRECTION_NONE
@@ -1682,6 +1683,7 @@
/**
dbusmenu_server_set_status:
@server: The #DbusmenuServer to set the status on
+ @status: Status value to set on the server
Changes the status of the server.
*/
=== modified file 'libdbusmenu-glib/server.h'
--- libdbusmenu-glib/server.h 2011-02-24 14:56:30 +0000
+++ libdbusmenu-glib/server.h 2011-02-24 15:38:18 +0000
@@ -93,7 +93,17 @@
* String to access property #DbusmenuServer:version
*/
#define DBUSMENU_SERVER_PROP_VERSION "version"
+/**
+ * DBUSMENU_SERVER_PROP_TEXT_DIRECTION:
+ *
+ * String to access property #DbusmenuServer:text-direction
+ */
#define DBUSMENU_SERVER_PROP_TEXT_DIRECTION "text-direction"
+/**
+ * DBUSMENU_SERVER_PROP_STATUS:
+ *
+ * String to access property #DbusmenuServer:status
+ */
#define DBUSMENU_SERVER_PROP_STATUS "status"
typedef struct _DbusmenuServerPrivate DbusmenuServerPrivate;
=== modified file 'libdbusmenu-glib/types.h'
--- libdbusmenu-glib/types.h 2011-02-18 21:16:54 +0000
+++ libdbusmenu-glib/types.h 2011-02-24 15:38:18 +0000
@@ -59,6 +59,17 @@
DBUSMENU_STATUS_NOTICE /*< nick=notice >*/
} DbusmenuStatus;
+/**
+ SECTION:types
+ @short_description: Types that are used by both client and
+ server.
+ @stability: Unstable
+ @include: libdbusmenu-glib/types.h
+
+ Enums that are used to describe states of the server across the
+ bus. They are sent over dbus using their nicks but then turned
+ back into enums by the client.
+*/
G_END_DECLS
#endif /* __DBUSMENU_TYPES_H__ */
