From: Karel Zak <kzak@redhat.com>
Date: Tue, 13 Jan 2015 11:23:40 +0000 (+0100)
Subject: libsmartcols: (docs) improve section descriptions
X-Git-Tag: v2.26-rc1~33
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=2473b711822be0e4280c76eba9ec30da1ec5457d;p=thirdparty%2Futil-linux.git

libsmartcols: (docs) improve section descriptions

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

diff --git a/libsmartcols/src/cell.c b/libsmartcols/src/cell.c
index b08532497a..49b4ac4653 100644
--- a/libsmartcols/src/cell.c
+++ b/libsmartcols/src/cell.c
@@ -11,7 +11,7 @@
 /**
  * SECTION: cell
  * @title: Cell
- * @short_description: cell API
+ * @short_description: container for your data
  *
  * 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
diff --git a/libsmartcols/src/column.c b/libsmartcols/src/column.c
index b3dd06ef87..821cc98106 100644
--- a/libsmartcols/src/column.c
+++ b/libsmartcols/src/column.c
@@ -11,7 +11,7 @@
 /**
  * SECTION: column
  * @title: Column
- * @short_description: column API
+ * @short_description: defines output columns formats, headers, etc.
  *
  * An API to access and modify per-column data and information.
  */
diff --git a/libsmartcols/src/line.c b/libsmartcols/src/line.c
index 6e83fb47f0..e1c3e1faba 100644
--- a/libsmartcols/src/line.c
+++ b/libsmartcols/src/line.c
@@ -11,7 +11,7 @@
 /**
  * SECTION: line
  * @title: Line
- * @short_description: line API
+ * @short_description: cells container, also keeps tree (parent->child) information
  *
  * An API to access and modify per-line data and information.
  */
diff --git a/libsmartcols/src/symbols.c b/libsmartcols/src/symbols.c
index 2b8f81dc93..c19df0255b 100644
--- a/libsmartcols/src/symbols.c
+++ b/libsmartcols/src/symbols.c
@@ -10,7 +10,7 @@
 /**
  * SECTION: symbols
  * @title: Symbols
- * @short_description: symbols API
+ * @short_description: allows to overwrite default output chars (for ascii art)
  *
  * An API to access and modify data and information per symbol/symbol group.
  */
diff --git a/libsmartcols/src/table.c b/libsmartcols/src/table.c
index 8c404f8581..0a381265f6 100644
--- a/libsmartcols/src/table.c
+++ b/libsmartcols/src/table.c
@@ -11,7 +11,7 @@
 /**
  * SECTION: table
  * @title: Table
- * @short_description: table data API
+ * @short_description: container for rows and columns
  *
  * Table data manipulation API.
  */
diff --git a/libsmartcols/src/table_print.c b/libsmartcols/src/table_print.c
index ddbd12d3f7..647692c0dc 100644
--- a/libsmartcols/src/table_print.c
+++ b/libsmartcols/src/table_print.c
@@ -10,7 +10,7 @@
 /**
  * SECTION: table_print
  * @title: Table print
- * @short_description: table print API
+ * @short_description: output functions
  *
  * Table output API.
  */