objects: Doxygen: more details on bt_object_null

[babeltrace.git] / include / babeltrace / objects.h

diff --git a/include/babeltrace/objects.h b/include/babeltrace/objects.h
index 77be607c054b3abfe07c4b86da11ad97fe0533e0..937297c5b16f8cae80ad66ccedb433d3e818e4b5 100644 (file)
--- 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