From d7bdd499237e6c389c86afd3375a80bf6dd1344a Mon Sep 17 00:00:00 2001 From: Andrea Zagli Date: Fri, 25 Jun 2010 20:52:10 +0200 Subject: [PATCH] Added gtk-doc files. --- docs/reference/autoz-decl-list.txt | 83 ++++++ docs/reference/autoz-decl.txt | 284 ++++++++++++++++++++ docs/reference/autoz-docs.sgml | 36 +++ docs/reference/autoz-overrides.txt | 0 docs/reference/autoz-sections.txt | 83 ++++++ docs/reference/autoz-undeclared.txt | 0 docs/reference/autoz-undocumented.txt | 47 ++++ docs/reference/autoz-unused.txt | 0 docs/reference/autoz.args | 0 docs/reference/autoz.hierarchy | 8 + docs/reference/autoz.interfaces | 2 + docs/reference/autoz.prerequisites | 2 + docs/reference/autoz.signals | 0 docs/reference/autoz.types | 5 + docs/reference/tmpl/autoz-unused.sgml | 0 docs/reference/tmpl/autoz.sgml | 181 +++++++++++++ docs/reference/tmpl/resource.sgml | 46 ++++ docs/reference/tmpl/resource_interface.sgml | 47 ++++ docs/reference/tmpl/role.sgml | 46 ++++ docs/reference/tmpl/role_interface.sgml | 47 ++++ 20 files changed, 917 insertions(+) create mode 100644 docs/reference/autoz-decl-list.txt create mode 100644 docs/reference/autoz-decl.txt create mode 100644 docs/reference/autoz-docs.sgml create mode 100644 docs/reference/autoz-overrides.txt create mode 100644 docs/reference/autoz-sections.txt create mode 100644 docs/reference/autoz-undeclared.txt create mode 100644 docs/reference/autoz-undocumented.txt create mode 100644 docs/reference/autoz-unused.txt create mode 100644 docs/reference/autoz.args create mode 100644 docs/reference/autoz.hierarchy create mode 100644 docs/reference/autoz.interfaces create mode 100644 docs/reference/autoz.prerequisites create mode 100644 docs/reference/autoz.signals create mode 100644 docs/reference/autoz.types create mode 100644 docs/reference/tmpl/autoz-unused.sgml create mode 100644 docs/reference/tmpl/autoz.sgml create mode 100644 docs/reference/tmpl/resource.sgml create mode 100644 docs/reference/tmpl/resource_interface.sgml create mode 100644 docs/reference/tmpl/role.sgml create mode 100644 docs/reference/tmpl/role_interface.sgml diff --git a/docs/reference/autoz-decl-list.txt b/docs/reference/autoz-decl-list.txt new file mode 100644 index 0000000..4540eaf --- /dev/null +++ b/docs/reference/autoz-decl-list.txt @@ -0,0 +1,83 @@ +
+role +AutozRole +AutozRole +AutozRoleClass +autoz_role_new + +AUTOZ_ROLE +AUTOZ_IS_ROLE +AUTOZ_TYPE_ROLE +autoz_role_get_type +AUTOZ_ROLE_CLASS +AUTOZ_IS_ROLE_CLASS +AUTOZ_ROLE_GET_CLASS +
+ +
+resource_interface +AutozIResource +AutozIResource +AutozIResourceIface +autoz_iresource_get_resource_id + +AUTOZ_IRESOURCE +AUTOZ_IS_IRESOURCE +AUTOZ_TYPE_IRESOURCE +autoz_iresource_get_type +AUTOZ_IRESOURCE_GET_IFACE +
+ +
+role_interface +AutozIRole +AutozIRole +AutozIRoleIface +autoz_irole_get_role_id + +AUTOZ_IROLE +AUTOZ_IS_IROLE +AUTOZ_TYPE_IROLE +autoz_irole_get_type +AUTOZ_IROLE_GET_IFACE +
+ +
+resource +AutozResource +AutozResource +AutozResourceClass +autoz_resource_new + +AUTOZ_RESOURCE +AUTOZ_IS_RESOURCE +AUTOZ_TYPE_RESOURCE +autoz_resource_get_type +AUTOZ_RESOURCE_CLASS +AUTOZ_IS_RESOURCE_CLASS +AUTOZ_RESOURCE_GET_CLASS +
+ +
+autoz +Autoz +TYPE_AUTOZ +AUTOZ +AUTOZ_CLASS +IS_AUTOZ +IS_AUTOZ_CLASS +AUTOZ_GET_CLASS +Autoz +AutozClass +autoz_get_type +autoz_new +autoz_add_role +autoz_add_role_with_parents +autoz_get_role_from_id +autoz_add_resource +autoz_add_resource_with_parents +autoz_get_resource_from_id +autoz_allow +autoz_is_allowed +
+ diff --git a/docs/reference/autoz-decl.txt b/docs/reference/autoz-decl.txt new file mode 100644 index 0000000..a6e8357 --- /dev/null +++ b/docs/reference/autoz-decl.txt @@ -0,0 +1,284 @@ + +TYPE_AUTOZ +#define TYPE_AUTOZ (autoz_get_type ()) + + +AUTOZ +#define AUTOZ(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), TYPE_AUTOZ, Autoz)) + + +AUTOZ_CLASS +#define AUTOZ_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), TYPE_AUTOZ, AutozClass)) + + +IS_AUTOZ +#define IS_AUTOZ(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), TYPE_AUTOZ)) + + +IS_AUTOZ_CLASS +#define IS_AUTOZ_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), TYPE_AUTOZ)) + + +AUTOZ_GET_CLASS +#define AUTOZ_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), TYPE_AUTOZ, AutozClass)) + + +Autoz + + +AutozClass + + +Autoz +struct _Autoz + { + GObject parent; + }; + + +AutozClass +struct _AutozClass + { + GObjectClass parent_class; + }; + + +autoz_get_type +GType +void + + +autoz_new +Autoz * +void + + +autoz_add_role +void +Autoz *autoz, AutozIRole *irole + + +autoz_add_role_with_parents +void +Autoz *autoz, AutozIRole *irole, ... + + +autoz_get_role_from_id +AutozIRole * +Autoz *autoz, const gchar *role_id + + +autoz_add_resource +void +Autoz *autoz, AutozIResource *iresource + + +autoz_add_resource_with_parents +void +Autoz *autoz, AutozIResource *iresource, ... + + +autoz_get_resource_from_id +AutozIResource * +Autoz *autoz, const gchar *resource_id + + +autoz_allow +void +Autoz *autoz, AutozIRole *irole, AutozIResource *iresource + + +autoz_is_allowed +gboolean +Autoz *autoz, AutozIRole *irole, AutozIResource *iresource + + +AUTOZ_TYPE_ROLE +#define AUTOZ_TYPE_ROLE (autoz_role_get_type ()) + + +AUTOZ_ROLE +#define AUTOZ_ROLE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), AUTOZ_TYPE_ROLE, AutozRole)) + + +AUTOZ_ROLE_CLASS +#define AUTOZ_ROLE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), AUTOZ_TYPE_ROLE, AutozRoleClass)) + + +AUTOZ_IS_ROLE +#define AUTOZ_IS_ROLE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), AUTOZ_TYPE_ROLE)) + + +AUTOZ_IS_ROLE_CLASS +#define AUTOZ_IS_ROLE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), AUTOZ_TYPE_ROLE)) + + +AUTOZ_ROLE_GET_CLASS +#define AUTOZ_ROLE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), AUTOZ_TYPE_ROLE, AutozRoleClass)) + + +AutozRole + + +AutozRoleClass + + +AutozRole +struct _AutozRole + { + GObject parent; + }; + + +AutozRoleClass +struct _AutozRoleClass + { + GObjectClass parent_class; + }; + + +autoz_role_get_type +GType +void + + +autoz_role_new +AutozRole * +const gchar *role_id + + +AUTOZ_TYPE_IRESOURCE +#define AUTOZ_TYPE_IRESOURCE (autoz_iresource_get_type ()) + + +AUTOZ_IRESOURCE +#define AUTOZ_IRESOURCE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), AUTOZ_TYPE_IRESOURCE, AutozIResource)) + + +AUTOZ_IS_IRESOURCE +#define AUTOZ_IS_IRESOURCE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), AUTOZ_TYPE_IRESOURCE)) + + +AUTOZ_IRESOURCE_GET_IFACE +#define AUTOZ_IRESOURCE_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), AUTOZ_TYPE_IRESOURCE, AutozIResourceIface)) + + +AutozIResource + + +AutozIResourceIface + + +AutozIResourceIface +struct _AutozIResourceIface + { + GTypeInterface g_iface; + + const gchar *(*get_resource_id) (AutozIResource *iresource); + }; + + +autoz_iresource_get_type +GType +void + + +autoz_iresource_get_resource_id +const gchar * +AutozIResource *iresource + + +AUTOZ_TYPE_IROLE +#define AUTOZ_TYPE_IROLE (autoz_irole_get_type ()) + + +AUTOZ_IROLE +#define AUTOZ_IROLE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), AUTOZ_TYPE_IROLE, AutozIRole)) + + +AUTOZ_IS_IROLE +#define AUTOZ_IS_IROLE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), AUTOZ_TYPE_IROLE)) + + +AUTOZ_IROLE_GET_IFACE +#define AUTOZ_IROLE_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), AUTOZ_TYPE_IROLE, AutozIRoleIface)) + + +AutozIRole + + +AutozIRoleIface + + +AutozIRoleIface +struct _AutozIRoleIface + { + GTypeInterface g_iface; + + const gchar *(*get_role_id) (AutozIRole *irole); + }; + + +autoz_irole_get_type +GType +void + + +autoz_irole_get_role_id +const gchar * +AutozIRole *irole + + +AUTOZ_TYPE_RESOURCE +#define AUTOZ_TYPE_RESOURCE (autoz_resource_get_type ()) + + +AUTOZ_RESOURCE +#define AUTOZ_RESOURCE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), AUTOZ_TYPE_RESOURCE, AutozResource)) + + +AUTOZ_RESOURCE_CLASS +#define AUTOZ_RESOURCE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), AUTOZ_TYPE_RESOURCE, AutozResourceClass)) + + +AUTOZ_IS_RESOURCE +#define AUTOZ_IS_RESOURCE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), AUTOZ_TYPE_RESOURCE)) + + +AUTOZ_IS_RESOURCE_CLASS +#define AUTOZ_IS_RESOURCE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), AUTOZ_TYPE_RESOURCE)) + + +AUTOZ_RESOURCE_GET_CLASS +#define AUTOZ_RESOURCE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), AUTOZ_TYPE_RESOURCE, AutozResourceClass)) + + +AutozResource + + +AutozResourceClass + + +AutozResource +struct _AutozResource + { + GObject parent; + }; + + +AutozResourceClass +struct _AutozResourceClass + { + GObjectClass parent_class; + }; + + +autoz_resource_get_type +GType +void + + +autoz_resource_new +AutozResource * +const gchar *resource_id + diff --git a/docs/reference/autoz-docs.sgml b/docs/reference/autoz-docs.sgml new file mode 100644 index 0000000..d3f257d --- /dev/null +++ b/docs/reference/autoz-docs.sgml @@ -0,0 +1,36 @@ + + +]> + + + autoz Reference Manual + + for autoz [VERSION]. + The latest version of this documentation can be found on-line at + http://[SERVER]/autoz/. + + + + + [Insert title here] + + + + + + + + + Object Hierarchy + + + + API Index + + + + + diff --git a/docs/reference/autoz-overrides.txt b/docs/reference/autoz-overrides.txt new file mode 100644 index 0000000..e69de29 diff --git a/docs/reference/autoz-sections.txt b/docs/reference/autoz-sections.txt new file mode 100644 index 0000000..4540eaf --- /dev/null +++ b/docs/reference/autoz-sections.txt @@ -0,0 +1,83 @@ +
+role +AutozRole +AutozRole +AutozRoleClass +autoz_role_new + +AUTOZ_ROLE +AUTOZ_IS_ROLE +AUTOZ_TYPE_ROLE +autoz_role_get_type +AUTOZ_ROLE_CLASS +AUTOZ_IS_ROLE_CLASS +AUTOZ_ROLE_GET_CLASS +
+ +
+resource_interface +AutozIResource +AutozIResource +AutozIResourceIface +autoz_iresource_get_resource_id + +AUTOZ_IRESOURCE +AUTOZ_IS_IRESOURCE +AUTOZ_TYPE_IRESOURCE +autoz_iresource_get_type +AUTOZ_IRESOURCE_GET_IFACE +
+ +
+role_interface +AutozIRole +AutozIRole +AutozIRoleIface +autoz_irole_get_role_id + +AUTOZ_IROLE +AUTOZ_IS_IROLE +AUTOZ_TYPE_IROLE +autoz_irole_get_type +AUTOZ_IROLE_GET_IFACE +
+ +
+resource +AutozResource +AutozResource +AutozResourceClass +autoz_resource_new + +AUTOZ_RESOURCE +AUTOZ_IS_RESOURCE +AUTOZ_TYPE_RESOURCE +autoz_resource_get_type +AUTOZ_RESOURCE_CLASS +AUTOZ_IS_RESOURCE_CLASS +AUTOZ_RESOURCE_GET_CLASS +
+ +
+autoz +Autoz +TYPE_AUTOZ +AUTOZ +AUTOZ_CLASS +IS_AUTOZ +IS_AUTOZ_CLASS +AUTOZ_GET_CLASS +Autoz +AutozClass +autoz_get_type +autoz_new +autoz_add_role +autoz_add_role_with_parents +autoz_get_role_from_id +autoz_add_resource +autoz_add_resource_with_parents +autoz_get_resource_from_id +autoz_allow +autoz_is_allowed +
+ diff --git a/docs/reference/autoz-undeclared.txt b/docs/reference/autoz-undeclared.txt new file mode 100644 index 0000000..e69de29 diff --git a/docs/reference/autoz-undocumented.txt b/docs/reference/autoz-undocumented.txt new file mode 100644 index 0000000..9b689e4 --- /dev/null +++ b/docs/reference/autoz-undocumented.txt @@ -0,0 +1,47 @@ +2% symbol docs coverage. +1 symbols documented. +5 symbols incomplete. +39 not documented. + + +AUTOZ +AUTOZ_CLASS +AUTOZ_GET_CLASS +Autoz +AutozClass () +AutozIResource +AutozIResourceIface () +AutozIRole +AutozIRoleIface () +AutozResource +AutozResourceClass () +AutozRole +AutozRoleClass () +IS_AUTOZ +IS_AUTOZ_CLASS +TYPE_AUTOZ +autoz_add_resource +autoz_add_resource_with_parents +autoz_add_role +autoz_add_role_with_parents +autoz_allow +autoz_get_resource_from_id +autoz_get_role_from_id +autoz_get_type +autoz_iresource_get_resource_id +autoz_irole_get_role_id +autoz_is_allowed +autoz_new +autoz_resource_new +autoz_role_new + + +autoz:Short_Description +resource:Long_Description +resource:Short_Description +resource_interface:Long_Description +resource_interface:Short_Description +role:Long_Description +role:Short_Description +role_interface:Long_Description +role_interface:Short_Description diff --git a/docs/reference/autoz-unused.txt b/docs/reference/autoz-unused.txt new file mode 100644 index 0000000..e69de29 diff --git a/docs/reference/autoz.args b/docs/reference/autoz.args new file mode 100644 index 0000000..e69de29 diff --git a/docs/reference/autoz.hierarchy b/docs/reference/autoz.hierarchy new file mode 100644 index 0000000..c92c2ab --- /dev/null +++ b/docs/reference/autoz.hierarchy @@ -0,0 +1,8 @@ +GObject + Autoz + AutozResource + AutozRole +GInterface + GTypePlugin + AutozIResource + AutozIRole diff --git a/docs/reference/autoz.interfaces b/docs/reference/autoz.interfaces new file mode 100644 index 0000000..642b295 --- /dev/null +++ b/docs/reference/autoz.interfaces @@ -0,0 +1,2 @@ +AutozResource AutozIResource +AutozRole AutozIRole diff --git a/docs/reference/autoz.prerequisites b/docs/reference/autoz.prerequisites new file mode 100644 index 0000000..8b67f96 --- /dev/null +++ b/docs/reference/autoz.prerequisites @@ -0,0 +1,2 @@ +AutozIResource GObject +AutozIRole GObject diff --git a/docs/reference/autoz.signals b/docs/reference/autoz.signals new file mode 100644 index 0000000..e69de29 diff --git a/docs/reference/autoz.types b/docs/reference/autoz.types new file mode 100644 index 0000000..3486940 --- /dev/null +++ b/docs/reference/autoz.types @@ -0,0 +1,5 @@ +autoz_get_type +autoz_iresource_get_type +autoz_irole_get_type +autoz_resource_get_type +autoz_role_get_type diff --git a/docs/reference/tmpl/autoz-unused.sgml b/docs/reference/tmpl/autoz-unused.sgml new file mode 100644 index 0000000..e69de29 diff --git a/docs/reference/tmpl/autoz.sgml b/docs/reference/tmpl/autoz.sgml new file mode 100644 index 0000000..306a089 --- /dev/null +++ b/docs/reference/tmpl/autoz.sgml @@ -0,0 +1,181 @@ + +Autoz + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@obj: + + + + + + + +@klass: + + + + + + + +@obj: + + + + + + + +@klass: + + + + + + + +@obj: + + + + + + + + + + + + + +@parent_class: + + + + + + +@void: +@Returns: + + + + + + + +@void: +@Returns: + + + + + + + +@autoz: +@irole: + + + + + + + +@autoz: +@irole: +@Varargs: + + + + + + + +@autoz: +@role_id: +@Returns: + + + + + + + +@autoz: +@iresource: + + + + + + + +@autoz: +@iresource: +@Varargs: + + + + + + + +@autoz: +@resource_id: +@Returns: + + + + + + + +@autoz: +@irole: +@iresource: + + + + + + + +@autoz: +@irole: +@iresource: +@Returns: + + diff --git a/docs/reference/tmpl/resource.sgml b/docs/reference/tmpl/resource.sgml new file mode 100644 index 0000000..4c9e278 --- /dev/null +++ b/docs/reference/tmpl/resource.sgml @@ -0,0 +1,46 @@ + +AutozResource + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@parent_class: + + + + + + +@resource_id: +@Returns: + + diff --git a/docs/reference/tmpl/resource_interface.sgml b/docs/reference/tmpl/resource_interface.sgml new file mode 100644 index 0000000..6164499 --- /dev/null +++ b/docs/reference/tmpl/resource_interface.sgml @@ -0,0 +1,47 @@ + +AutozIResource + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@g_iface: +@get_resource_id: + + + + + + +@iresource: +@Returns: + + diff --git a/docs/reference/tmpl/role.sgml b/docs/reference/tmpl/role.sgml new file mode 100644 index 0000000..c0a9465 --- /dev/null +++ b/docs/reference/tmpl/role.sgml @@ -0,0 +1,46 @@ + +AutozRole + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@parent_class: + + + + + + +@role_id: +@Returns: + + diff --git a/docs/reference/tmpl/role_interface.sgml b/docs/reference/tmpl/role_interface.sgml new file mode 100644 index 0000000..2f8e03d --- /dev/null +++ b/docs/reference/tmpl/role_interface.sgml @@ -0,0 +1,47 @@ + +AutozIRole + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@g_iface: +@get_role_id: + + + + + + +@irole: +@Returns: + + -- 2.49.0