libsmartcols: add note about deallocations

Signed-off-by: Karel Zak <kzak@redhat.com>

diff --git a/libsmartcols/src/column.c b/libsmartcols/src/column.c
index 7ba284c6e00f44aa1c7fe17c15216e8a3cfd5d50..b3dd06ef8788c5c1f5fb50c922a05613c8403d8d 100644 (file)
--- a/libsmartcols/src/column.c
+++ b/libsmartcols/src/column.c
@@ -60,7 +60,8 @@ void scols_ref_column(struct libscols_column *cl)
  * scols_unref_column:
  * @cl: a pointer to a struct libscols_column instance
  *
- * Decreases the refcount of @cl.
+ * Decreases the refcount of @cl. When the count falls to zero, the instance
+ * is automatically deallocated.
  */
 void scols_unref_column(struct libscols_column *cl)
 {

diff --git a/libsmartcols/src/line.c b/libsmartcols/src/line.c
index 0ed765dcdf2c459f21027323f5890bc5a77e40e0..ab2f191b39d141fce72218923935f6a912790f23 100644 (file)
--- a/libsmartcols/src/line.c
+++ b/libsmartcols/src/line.c
@@ -66,7 +66,8 @@ void scols_ref_line(struct libscols_line *ln)
  * scols_unref_line:
  * @ln: a pointer to a struct libscols_line instance
  *
- * Decreases the refcount of @ln.
+ * Decreases the refcount of @ln. When the count falls to zero, the instance
+ * is automatically deallocated.
  */
 void scols_unref_line(struct libscols_line *ln)
 {

diff --git a/libsmartcols/src/table.c b/libsmartcols/src/table.c
index 53590038aaf9456ef11fb37f0efab3f46b8cbf56..8c404f8581a9b6db25f8a516a203758e92cebeeb 100644 (file)
--- a/libsmartcols/src/table.c
+++ b/libsmartcols/src/table.c
@@ -77,7 +77,8 @@ void scols_ref_table(struct libscols_table *tb)
  * scols_unref_table:
  * @tb: a pointer to a struct libscols_table instance
  *
- * Decreases the refcount of @tb.
+ * Decreases the refcount of @tb. When the count falls to zero, the instance
+ * is automatically deallocated.
  */
 void scols_unref_table(struct libscols_table *tb)
 {