From 1d90bcb1a82cea0c994425cb12e2df436107168c Mon Sep 17 00:00:00 2001 From: Ondrej Oprala Date: Tue, 25 Mar 2014 15:09:09 +0100 Subject: libsmartcols: documentation Signed-off-by: Ondrej Oprala --- libsmartcols/docs/.gitignore | 18 ++++ libsmartcols/docs/Makefile.am | 93 +++++++++++++++++++++ libsmartcols/docs/libsmartcols-docs.xml | 50 +++++++++++ libsmartcols/docs/libsmartcols-sections.txt | 124 ++++++++++++++++++++++++++++ libsmartcols/docs/version.xml.in | 1 + 5 files changed, 286 insertions(+) create mode 100644 libsmartcols/docs/.gitignore create mode 100644 libsmartcols/docs/Makefile.am create mode 100644 libsmartcols/docs/libsmartcols-docs.xml create mode 100644 libsmartcols/docs/libsmartcols-sections.txt create mode 100644 libsmartcols/docs/version.xml.in (limited to 'libsmartcols/docs') diff --git a/libsmartcols/docs/.gitignore b/libsmartcols/docs/.gitignore new file mode 100644 index 000000000..f91f93db7 --- /dev/null +++ b/libsmartcols/docs/.gitignore @@ -0,0 +1,18 @@ +*-decl-list.txt +*-decl.txt +*-overrides.txt +*-undeclared.txt +*-undocumented.txt +*-unused.txt +*.args +*.bak +*.hierarchy +*.interfaces +*.prerequisites +*.signals +*.stamp +*.types +html/* +tmpl/* +version.xml +xml/* diff --git a/libsmartcols/docs/Makefile.am b/libsmartcols/docs/Makefile.am new file mode 100644 index 000000000..c5aa2237c --- /dev/null +++ b/libsmartcols/docs/Makefile.am @@ -0,0 +1,93 @@ +## Process this file with automake to produce Makefile.in + +# We require automake 1.10 at least. +AUTOMAKE_OPTIONS = 1.10 + +# This is a blank Makefile.am for using gtk-doc. +# Copy this to your project's API docs directory and modify the variables to +# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples +# of using the various options. + +# The name of the module, e.g. 'glib'. +DOC_MODULE=libsmartcols + +# Uncomment for versioned docs and specify the version of the module, e.g. '2'. +#DOC_MODULE_VERSION=2 + +# The top-level SGML file. You can change this if you want to. +DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml + +# The directory containing the source code. Relative to $(srcdir). +# gtk-doc will search all .c & .h files beneath here for inline comments +# documenting the functions and macros. +# e.g. DOC_SOURCE_DIR=../../../gtk +DOC_SOURCE_DIR=../src + +# Extra options to pass to gtkdoc-scangobj. Not normally needed. +SCANGOBJ_OPTIONS= + +# Extra options to supply to gtkdoc-scan. +# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" +SCAN_OPTIONS= + +# Extra options to supply to gtkdoc-mkdb. +# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml +MKDB_OPTIONS=--sgml-mode --output-format=xml --name-space mnt + +# Extra options to supply to gtkdoc-mktmpl +# e.g. MKTMPL_OPTIONS=--only-section-tmpl +MKTMPL_OPTIONS= + +# Extra options to supply to gtkdoc-mkhtml +MKHTML_OPTIONS= + +# Extra options to supply to gtkdoc-fixref. Not normally needed. +# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html +FIXXREF_OPTIONS= + +# Used for dependencies. The docs will be rebuilt if any of these change. +# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h +# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c +HFILE_GLOB=$(top_builddir)/libsmartcols/src/libsmartcols.h +CFILE_GLOB=$(top_srcdir)/libsmartcols/src/*.c + +# Extra header to include when scanning, which are not under DOC_SOURCE_DIR +# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h +EXTRA_HFILES= + +# Header files to ignore when scanning. Use base file name, no paths +# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h +IGNORE_HFILES=smartcolsP.h + +# Images to copy into HTML directory. +# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png +HTML_IMAGES= + +# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). +# e.g. content_files=running.sgml building.sgml changes-2.0.sgml +content_files = $(builddir)/version.xml + +# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded +# These files must be listed here *and* in content_files +# e.g. expand_content_files=running.sgml +expand_content_files= + +# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library. +# Only needed if you are using gtkdoc-scangobj to dynamically query widget +# signals and properties. +# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS) +# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib) +GTKDOC_CFLAGS= +GTKDOC_LIBS= + +# This includes the standard gtk-doc make rules, copied by gtkdocize. +include $(top_srcdir)/config/gtk-doc.make + +# Other files to distribute +# e.g. EXTRA_DIST += version.xml.in +EXTRA_DIST += version.xml.in + +# Files not to distribute +# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types +# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt +DISTCLEANFILES += version.xml diff --git a/libsmartcols/docs/libsmartcols-docs.xml b/libsmartcols/docs/libsmartcols-docs.xml new file mode 100644 index 000000000..a699fd07b --- /dev/null +++ b/libsmartcols/docs/libsmartcols-docs.xml @@ -0,0 +1,50 @@ + + +]> + + + libsmartcols Reference Manual + for libsmartcols version &version; + + 2014 + Karel Zak <kzak@redhat.com> + + + + + libsmartcols Overview + + +The libsmartcols library is used for smart adaptive formatting of tabular data. + + +The library is part of the util-linux package since version 2.25 and is +available from ftp://ftp.kernel.org/pub/linux/utils/util-linux/. + + + + + + Data manipulation + + + + + + + + Printing + + + + Misc + + + + API Index + + + diff --git a/libsmartcols/docs/libsmartcols-sections.txt b/libsmartcols/docs/libsmartcols-sections.txt new file mode 100644 index 000000000..c60d16b64 --- /dev/null +++ b/libsmartcols/docs/libsmartcols-sections.txt @@ -0,0 +1,124 @@ +
+cell +libscols_cell +scols_cell_copy_content +scols_cell_get_color +scols_cell_get_data +scols_cell_refer_data +scols_cell_set_color +scols_cell_set_data +scols_reset_cell +
+ +
+column +libscols_column +scols_column_get_color +scols_column_get_flags +scols_column_get_header +scols_column_get_whint +scols_column_is_no_extremes +scols_column_is_right +scols_column_is_strict_width +scols_column_is_tree +scols_column_is_trunc +scols_column_set_color +scols_column_set_flags +scols_column_set_whint +scols_copy_column +scols_new_column +scols_ref_column +scols_unref_column +
+ +
+iter +libscols_iter +scols_free_iter +scols_iter_get_direction +scols_new_iter +scols_reset_iter +
+ +
+line +libscols_line +scols_copy_line +scols_line_add_child +scols_line_alloc_cells +scols_line_free_cells +scols_line_get_cell +scols_line_get_color +scols_line_get_ncells +scols_line_get_parent +scols_line_get_userdata +scols_line_has_children +scols_line_next_child +scols_line_refer_data +scols_line_remove_child +scols_line_set_color +scols_line_set_data +scols_line_set_userdata +scols_new_line +scols_ref_line +scols_unref_line +
+ +
+symbols +libscols_symbols +scols_copy_symbols +scols_new_symbols +scols_ref_symbols +scols_symbols_set_branch +scols_symbols_set_right +scols_symbols_set_vertical +scols_unref_symbols +
+ +
+table +libscols_table +scols_copy_table +scols_new_table +scols_ref_table +scols_table_add_column +scols_table_add_line +scols_table_colors_wanted +scols_table_enable_colors +scols_table_get_column +scols_table_get_line +scols_table_get_ncols +scols_table_get_nlines +scols_table_get_stream +scols_table_is_ascii +scols_table_is_export +scols_table_is_max +scols_table_is_no_headings +scols_table_is_raw +scols_table_is_tree +scols_table_new_column +scols_table_new_line +scols_table_next_column +scols_table_next_line +scols_table_reduce_termwidth +scols_table_remove_column +scols_table_remove_columns +scols_table_remove_line +scols_table_remove_lines +scols_table_set_ascii +scols_table_set_export +scols_table_set_max +scols_table_set_no_headings +scols_table_set_raw +scols_table_set_stream +scols_table_set_symbols +scols_table_set_tree +scols_unref_table +
+ +
+table_print +scols_print_table +scols_print_table_to_string +
diff --git a/libsmartcols/docs/version.xml.in b/libsmartcols/docs/version.xml.in new file mode 100644 index 000000000..d78bda934 --- /dev/null +++ b/libsmartcols/docs/version.xml.in @@ -0,0 +1 @@ +@VERSION@ -- cgit v1.2.3-55-g7522