summaryrefslogtreecommitdiffstats
path: root/libsmartcols
diff options
context:
space:
mode:
authorKarel Zak2016-09-27 12:52:47 +0200
committerKarel Zak2016-09-27 12:52:47 +0200
commit81b176c4da088c483c2cd4dea6f2e3e34a37f2be (patch)
treeb3725945e43a9bd540cf2d729967c505cb387299 /libsmartcols
parentlibfdisk: (docs) add missing version notes (diff)
downloadkernel-qcow2-util-linux-81b176c4da088c483c2cd4dea6f2e3e34a37f2be.tar.gz
kernel-qcow2-util-linux-81b176c4da088c483c2cd4dea6f2e3e34a37f2be.tar.xz
kernel-qcow2-util-linux-81b176c4da088c483c2cd4dea6f2e3e34a37f2be.zip
docs: some random fixes
Signed-off-by: Karel Zak <kzak@redhat.com>
Diffstat (limited to 'libsmartcols')
-rw-r--r--libsmartcols/docs/libsmartcols-sections.txt14
-rw-r--r--libsmartcols/src/column.c8
-rw-r--r--libsmartcols/src/libsmartcols.h.in2
3 files changed, 13 insertions, 11 deletions
diff --git a/libsmartcols/docs/libsmartcols-sections.txt b/libsmartcols/docs/libsmartcols-sections.txt
index f05d45479..0c6d23d46 100644
--- a/libsmartcols/docs/libsmartcols-sections.txt
+++ b/libsmartcols/docs/libsmartcols-sections.txt
@@ -21,10 +21,10 @@ libscols_column
scols_column_get_color
scols_column_get_flags
scols_column_get_header
-scols_column_get_safechars;
-scols_column_get_table;
+scols_column_get_safechars
+scols_column_get_table
scols_column_get_whint
-scols_column_is_customwrap;
+scols_column_is_customwrap
scols_column_is_hidden
scols_column_is_noextremes
scols_column_is_right
@@ -35,15 +35,15 @@ scols_column_is_wrap
scols_column_set_cmpfunc
scols_column_set_color
scols_column_set_flags
-scols_column_set_safechars;
+scols_column_set_safechars
scols_column_set_whint
-scols_column_set_wrapfunc;
+scols_column_set_wrapfunc
scols_copy_column
scols_new_column
scols_ref_column
scols_unref_column
-scols_wrapnl_chunksize;
-scols_wrapnl_nextchunk;
+scols_wrapnl_chunksize
+scols_wrapnl_nextchunk
</SECTION>
<SECTION>
diff --git a/libsmartcols/src/column.c b/libsmartcols/src/column.c
index bfcda05c7..2dee2c02a 100644
--- a/libsmartcols/src/column.c
+++ b/libsmartcols/src/column.c
@@ -244,7 +244,7 @@ const char *scols_column_get_color(const struct libscols_column *cl)
* scols_wrapnl_nextchunk:
* @cl: a pointer to a struct libscols_column instance
* @data: string
- * @userdata: any data or NULL
+ * @userdata: callback private data
*
* This is build-in function for scols_column_set_wrapfunc(). This function
* terminates the current chunk by \0 and returns pointer to the begin of
@@ -273,6 +273,7 @@ char *scols_wrapnl_nextchunk(const struct libscols_column *cl __attribute__((unu
* scols_wrapnl_chunksize:
* @cl: a pointer to a struct libscols_column instance
* @data: string
+ * @userdata: callback private data
*
* Analyzes @data and returns size of the largest chunk. The chunks are based
* on \n. For example for data "AAA\nBBB\nCCCC" the largest chunk size is 4.
@@ -335,6 +336,7 @@ int scols_column_set_cmpfunc(struct libscols_column *cl,
* @cl: a pointer to a struct libscols_column instance
* @wrap_chunksize: function to return size of the largest chink of data
* @wrap_nextchunk: function to return next zero terminated data
+ * @userdata: optional stuff for callbacks
*
* Extends SCOLS_FL_WRAP and allows to set custom wrap function. The default
* is to wrap by column size, but you can create functions to wrap for example
@@ -351,14 +353,14 @@ int scols_column_set_wrapfunc(struct libscols_column *cl,
char * (*wrap_nextchunk)(const struct libscols_column *,
char *,
void *),
- void *data)
+ void *userdata)
{
if (!cl)
return -EINVAL;
cl->wrap_nextchunk = wrap_nextchunk;
cl->wrap_chunksize = wrap_chunksize;
- cl->wrapfunc_data = data;
+ cl->wrapfunc_data = userdata;
return 0;
}
diff --git a/libsmartcols/src/libsmartcols.h.in b/libsmartcols/src/libsmartcols.h.in
index de45892f2..94b1aada2 100644
--- a/libsmartcols/src/libsmartcols.h.in
+++ b/libsmartcols/src/libsmartcols.h.in
@@ -173,7 +173,7 @@ extern int scols_column_set_wrapfunc(struct libscols_column *cl,
const char *, void *),
char * (*wrap_nextchunk)(const struct libscols_column *,
char *, void *),
- void *data);
+ void *userdata);
extern char *scols_wrapnl_nextchunk(const struct libscols_column *cl, char *data, void *userdata);
extern size_t scols_wrapnl_chunksize(const struct libscols_column *cl, const char *data, void *userdata);