diff options
author | Brian Cameron <bcameron@src.gnome.org> | 2001-05-16 12:40:29 +0000 |
---|---|---|
committer | Brian Cameron <bcameron@src.gnome.org> | 2001-05-16 12:40:29 +0000 |
commit | e5d4548d3f59062dd2b9923826ef86ac3b626524 (patch) | |
tree | 02a65f01dd66e6812319ccd133de6cf1f7d65536 /atk/atkregistry.c | |
parent | efcdf4bdfa016bbcbcac4669101f19c09d25e6e8 (diff) | |
download | atk-e5d4548d3f59062dd2b9923826ef86ac3b626524.tar.gz |
Added better gtk-doc comments.
Diffstat (limited to 'atk/atkregistry.c')
-rw-r--r-- | atk/atkregistry.c | 52 |
1 files changed, 49 insertions, 3 deletions
diff --git a/atk/atkregistry.c b/atk/atkregistry.c index 8ad9847..89f4a42 100644 --- a/atk/atkregistry.c +++ b/atk/atkregistry.c @@ -116,7 +116,18 @@ atk_registry_finalize (GObject *instance) g_free (registry->factory_singleton_cache); } - +/** + *atk_registry_set_factory_type: + *@registry: the #AtkRegistry in which to register the association + * between an #AtkObjectFactory #GType and an #AtkObject @GType + *@type: an #AtkObject #GType + *@factory_type: an #AtkObjectFactory #GType to associate with @type + * + *Associate an #AtkObjectFactory subclass with a #GType. Note: + * The associated @factory_type will thereafter be responsible for + * the creation of new #AtkObject implementations for instances + * of type @type. + **/ void atk_registry_set_factory_type (AtkRegistry *registry, GType type, @@ -152,6 +163,18 @@ atk_registry_set_factory_type (AtkRegistry *registry, GUINT_TO_POINTER (factory_type)); } +/** + *atk_registry_get_factory_type: + *@registry: an #AtkRegistry + *@type: a #GType with which to look up the associated #AtkObjectFactory + * subclass + * + *Provides a GType indicating the #AtkObjectFactory subclass + * associated with type @type + * + *Returns: a GType indicating the AtkObjectFactory subclass + * associated with type @type + **/ GType atk_registry_get_factory_type (AtkRegistry *registry, GType type) @@ -179,7 +202,17 @@ atk_registry_get_factory_type (AtkRegistry *registry, return factory_type; } - +/** + *atk_registry_get_factory: + *@registry: an #AtkRegistry + *@type: a #GType with which to look up the associated #AtkObjectFactory + * + *Returns an #AtkObjectFactory appropriate for creating #AtkObjects + * of type @type. + * + *Returns: an #AtkObjectFactory appropriate for creating #AtkObjects + * of type @type. + **/ AtkObjectFactory* atk_registry_get_factory (AtkRegistry *registry, GType type) @@ -217,7 +250,20 @@ atk_registry_get_factory (AtkRegistry *registry, return ATK_OBJECT_FACTORY (factory_pointer); } - +/** + *atk_get_default_registry: + * + *Return a default implementation of the #AtkObjectFactory/type + * registry. + *Note: For most toolkit maintainers, this will be the correct + * registry for registering new #AtkObject factories. Following + * a call to this function, maintainers may call atk_registry_set_factory_type() + * to associate an #AtkObjectFactory subclass with the GType of objects + * for whom accessability information will be provided. + * + *Returns: a default implementation of the #AtkObjectFactory/type + * registry + **/ AtkRegistry* atk_get_default_registry () { |