From: Philippe Proulx Date: Thu, 19 Mar 2015 03:59:58 +0000 (-0400) Subject: objects: Doxygen: more details on bt_object_null X-Git-Tag: v2.0.0-pre1~1298 X-Git-Url: http://git.efficios.com/?a=commitdiff_plain;h=e0f99b7f035b3f43bbab9620af1efa539709f4ef;p=babeltrace.git objects: Doxygen: more details on bt_object_null Signed-off-by: Philippe Proulx Signed-off-by: Jérémie Galarneau --- diff --git a/include/babeltrace/objects.h b/include/babeltrace/objects.h index 77be607c..937297c5 100644 --- a/include/babeltrace/objects.h +++ b/include/babeltrace/objects.h @@ -202,10 +202,14 @@ struct bt_object; /** * The null object singleton. * - * Use this everytime you need a null object. The null object singleton - * has no reference count; there's only one. You may directly compare - * any object to the null singleton to find out if it's a null object, - * or otherwise use bt_object_is_null(). + * Use this everytime you need a null object. + * + * The null object singleton has no reference count; there's only one. + * You may directly compare any object to the null object singleton to + * find out if it's a null object, or otherwise use bt_object_is_null(). + * + * The null object singleton is always frozen (see bt_object_freeze() + * and bt_object_is_frozen()). * * Functions of this API return this when the object is actually a * null object (of type #BT_OBJECT_TYPE_NULL), whereas \c NULL means an