mirror of
https://gitlab.xiph.org/xiph/icecast-common.git
synced 2024-12-04 14:46:31 -05:00
Feature: Added some docs for the igloo_ro_new*() macros
This commit is contained in:
parent
b9dd0ee031
commit
f0a7c1ee9d
@ -281,10 +281,22 @@ int igloo_RO_HAS_TYPE_raw(igloo_ro_t object, const igloo_ro_type_t *
|
|||||||
|
|
||||||
#define igloo_RO_IS_SAME(a,b) (igloo_RO__GETBASE((a)) == igloo_RO__GETBASE((b)))
|
#define igloo_RO_IS_SAME(a,b) (igloo_RO__GETBASE((a)) == igloo_RO__GETBASE((b)))
|
||||||
|
|
||||||
/* Create a new refobject
|
/* Create a new refobject.
|
||||||
* The type argument gives the type for the new object,
|
*
|
||||||
* the name for the object is given by name, and
|
* Parameters:
|
||||||
* the associated refobject is given by associated.
|
* type
|
||||||
|
* The type of new object to create.
|
||||||
|
* name
|
||||||
|
* The name of the object to create or NULL.
|
||||||
|
* associated
|
||||||
|
* The object that is associated with this object or igloo_RO_NULL.
|
||||||
|
* instance
|
||||||
|
* The instance of libigloo to use to create this object.
|
||||||
|
* If an non-instance object is given the same instance is used as used for that object.
|
||||||
|
* This allows easy building of child objects without the need to carry around the instance
|
||||||
|
* object.
|
||||||
|
* If igloo_RO_NULL libigloo will try to find a suitable instance. This is deprecated. And
|
||||||
|
* future versions my enforce a non-igloo_RO_NULL value.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
igloo_ro_t igloo_ro_new__raw(const igloo_ro_type_t *type, const char *name, igloo_ro_t associated, igloo_ro_t instance);
|
igloo_ro_t igloo_ro_new__raw(const igloo_ro_type_t *type, const char *name, igloo_ro_t associated, igloo_ro_t instance);
|
||||||
|
Loading…
Reference in New Issue
Block a user