summaryrefslogtreecommitdiffstats
path: root/libsmartcols/src/cell.c
diff options
context:
space:
mode:
authorKarel Zak2014-04-07 14:07:49 +0200
committerKarel Zak2014-04-07 14:07:49 +0200
commite2310281c74bfaae4d3618ddd5d0568c494eda6a (patch)
tree04d5c5bc739c38f1cb5f67e6c77e0e91039e0313 /libsmartcols/src/cell.c
parentlibsmartcols: add debug and version functions (diff)
downloadkernel-qcow2-util-linux-e2310281c74bfaae4d3618ddd5d0568c494eda6a.tar.gz
kernel-qcow2-util-linux-e2310281c74bfaae4d3618ddd5d0568c494eda6a.tar.xz
kernel-qcow2-util-linux-e2310281c74bfaae4d3618ddd5d0568c494eda6a.zip
libsmartcols: improve docs
Signed-off-by: Karel Zak <kzak@redhat.com>
Diffstat (limited to 'libsmartcols/src/cell.c')
-rw-r--r--libsmartcols/src/cell.c6
1 files changed, 4 insertions, 2 deletions
diff --git a/libsmartcols/src/cell.c b/libsmartcols/src/cell.c
index 28e255786..491b8a15c 100644
--- a/libsmartcols/src/cell.c
+++ b/libsmartcols/src/cell.c
@@ -13,7 +13,9 @@
* @title: Cell
* @short_description: cell API
*
- * An API to access and modify per-cell data and information.
+ * An API to access and modify per-cell data and information. Note that cell is
+ * always part of the line. If you destroy (un-reference) a line than it
+ * destroys all line cells too.
*/
@@ -146,7 +148,7 @@ int scols_cell_set_color(struct libscols_cell *ce, const char *color)
}
/**
- * scols_cell_get_data:
+ * scols_cell_get_color:
* @ce: a pointer to a struct libscols_cell instance
*
* Returns: the current color of @ce.