]> git.ipfire.org Git - thirdparty/util-linux.git/commitdiff
libsmartcols: (docs) improve section descriptions
authorKarel Zak <kzak@redhat.com>
Tue, 13 Jan 2015 11:23:40 +0000 (12:23 +0100)
committerKarel Zak <kzak@redhat.com>
Tue, 13 Jan 2015 11:23:40 +0000 (12:23 +0100)
Signed-off-by: Karel Zak <kzak@redhat.com>
libsmartcols/src/cell.c
libsmartcols/src/column.c
libsmartcols/src/line.c
libsmartcols/src/symbols.c
libsmartcols/src/table.c
libsmartcols/src/table_print.c

index b08532497abaa915971ab55cf4866ee4d390318c..49b4ac4653b5a9f84bd109813e5dca071f256640 100644 (file)
@@ -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
index b3dd06ef8788c5c1f5fb50c922a05613c8403d8d..821cc9810604b9b0257d0216eee07834083e6d47 100644 (file)
@@ -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.
  */
index 6e83fb47f0cd6d1321f5c3cf3ca2b890d4f9311e..e1c3e1fabafb23153b09a58a4acb50d68228bdf0 100644 (file)
@@ -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.
  */
index 2b8f81dc93ee14c034cff954c5cd4cbb1c77af52..c19df0255bafcd65c7f2f0cb1c66631a676006a6 100644 (file)
@@ -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.
  */
index 8c404f8581a9b6db25f8a516a203758e92cebeeb..0a381265f6597cd0f3db90d14bfe06c2c7d72c81 100644 (file)
@@ -11,7 +11,7 @@
 /**
  * SECTION: table
  * @title: Table
- * @short_description: table data API
+ * @short_description: container for rows and columns
  *
  * Table data manipulation API.
  */
index ddbd12d3f77eb730b8da9297b61953cf23940de4..647692c0dc7510d8cd0f6c35d9ed2cd057fa32f0 100644 (file)
@@ -10,7 +10,7 @@
 /**
  * SECTION: table_print
  * @title: Table print
- * @short_description: table print API
+ * @short_description: output functions
  *
  * Table output API.
  */