libgnt/libgnt

doc: Improve section descriptions.

2019-04-13, Elliott Sales de Andrade
b82a6caa66e0
Parents d3e290421686
Children f42fc12cfe5a
doc: Improve section descriptions.
28 files changed, 61 insertions(+), 56 deletions(-)
  • +2 -2
    gnt-skel.h
  • +2 -2
    gnt.h.in
  • +2 -2
    gntbindable.h
  • +2 -2
    gntbox.h
  • +3 -2
    gntbutton.h
  • +3 -2
    gntcheckbox.h
  • +2 -2
    gntclipboard.h
  • +1 -1
    gntcolors.h
  • +2 -2
    gntcombobox.h
  • +2 -2
    gntentry.h
  • +2 -2
    gntfilesel.h
  • +2 -2
    gntkeys.h
  • +2 -2
    gntlabel.h
  • +2 -2
    gntline.h
  • +3 -2
    gntmenu.h
  • +3 -2
    gntmenuitem.h
  • +3 -2
    gntmenuitemcheck.h
  • +2 -2
    gntprogressbar.h
  • +2 -2
    gntslider.h
  • +2 -2
    gntstyle.h
  • +2 -2
    gnttextview.h
  • +2 -2
    gnttree.h
  • +1 -1
    gntutils.h
  • +4 -4
    gntversion.h.in
  • +2 -2
    gntwidget.h
  • +2 -2
    gntwindow.h
  • +2 -2
    gntwm.h
  • +2 -2
    gntws.h
    • --- a/gnt-skel.h Sat Apr 13 03:23:31 2019 -0400
    +++ b/gnt-skel.h Sat Apr 13 05:05:59 2019 -0400
    @@ -25,8 +25,8 @@
    /*
    * SECTION:gnt-skel
    * @section_id: libgnt-gnt-skel
    - * @short_description: <filename>gnt-skel.h</filename>
    - * @title: Skel API
    + * @title: GntSkel
    + * @short_description: A skeleton of an example widget
    */
    #include "gntwidget.h"
    --- a/gnt.h.in Sat Apr 13 03:23:31 2019 -0400
    +++ b/gnt.h.in Sat Apr 13 05:05:59 2019 -0400
    @@ -25,8 +25,8 @@
    /**
    * SECTION:gnt
    * @section_id: libgnt-gnt
    - * @short_description: <filename>gnt.h</filename>
    - * @title: GNT API
    + * @title: General
    + * @short_description: General API for managing GNT
    */
    #include <glib.h>
    --- a/gntbindable.h Sat Apr 13 03:23:31 2019 -0400
    +++ b/gntbindable.h Sat Apr 13 05:05:59 2019 -0400
    @@ -25,8 +25,8 @@
    /**
    * SECTION:gntbindable
    * @section_id: libgnt-gntbindable
    - * @short_description: <filename>gntbindable.h</filename>
    - * @title: Bindable
    + * @title: GntBindable
    + * @short_description: Key-bindable GObjects
    */
    #include <stdio.h>
    --- a/gntbox.h Sat Apr 13 03:23:31 2019 -0400
    +++ b/gntbox.h Sat Apr 13 05:05:59 2019 -0400
    @@ -25,8 +25,8 @@
    /**
    * SECTION:gntbox
    * @section_id: libgnt-gntbox
    - * @short_description: <filename>gntbox.h</filename>
    - * @title: Box
    + * @title: GntBox
    + * @short_description: A box for packing widgets in a single row or column
    */
    #include "gnt.h"
    --- a/gntbutton.h Sat Apr 13 03:23:31 2019 -0400
    +++ b/gntbutton.h Sat Apr 13 05:05:59 2019 -0400
    @@ -25,8 +25,9 @@
    /**
    * SECTION:gntbutton
    * @section_id: libgnt-gntbutton
    - * @short_description: <filename>gntbutton.h</filename>
    - * @title: Button
    + * @title: GntButton
    + * @short_description: A widget that can be activated
    + * @see_also: #GntCheckBox
    */
    #include <glib.h>
    --- a/gntcheckbox.h Sat Apr 13 03:23:31 2019 -0400
    +++ b/gntcheckbox.h Sat Apr 13 05:05:59 2019 -0400
    @@ -25,8 +25,9 @@
    /**
    * SECTION:gntcheckbox
    * @section_id: libgnt-gntcheckbox
    - * @short_description: <filename>gntcheckbox.h</filename>
    - * @title: Checkbox
    + * @title: GntCheckbox
    + * @short_description: A widget that can be toggled
    + * @see_also: #GntButton
    */
    #include "gntbutton.h"
    --- a/gntclipboard.h Sat Apr 13 03:23:31 2019 -0400
    +++ b/gntclipboard.h Sat Apr 13 05:05:59 2019 -0400
    @@ -25,8 +25,8 @@
    /**
    * SECTION:gntclipboard
    * @section_id: libgnt-gntclipboard
    - * @short_description: <filename>gntclipboard.h</filename>
    - * @title: Clipboard
    + * @title: GntClipboard
    + * @short_description: A short-term text storage buffer
    */
    #include <glib.h>
    --- a/gntcolors.h Sat Apr 13 03:23:31 2019 -0400
    +++ b/gntcolors.h Sat Apr 13 05:05:59 2019 -0400
    @@ -25,8 +25,8 @@
    /**
    * SECTION:gntcolors
    * @section_id: libgnt-gntcolors
    - * @short_description: <filename>gntcolors.h</filename>
    * @title: Colors
    + * @short_description: Managing and parsing colors
    */
    #include <glib.h>
    --- a/gntcombobox.h Sat Apr 13 03:23:31 2019 -0400
    +++ b/gntcombobox.h Sat Apr 13 05:05:59 2019 -0400
    @@ -25,8 +25,8 @@
    /**
    * SECTION:gntcombobox
    * @section_id: libgnt-gntcombobox
    - * @short_description: <filename>gntcombobox.h</filename>
    - * @title: Combobox
    + * @title: GntComboBox
    + * @short_description: A widget for selecting between multiple choices
    */
    #include "gnt.h"
    --- a/gntentry.h Sat Apr 13 03:23:31 2019 -0400
    +++ b/gntentry.h Sat Apr 13 05:05:59 2019 -0400
    @@ -25,8 +25,8 @@
    /**
    * SECTION:gntentry
    * @section_id: libgnt-gntentry
    - * @short_description: <filename>gntentry.h</filename>
    - * @title: Entry
    + * @title: GntEntry
    + * @short_description: A widget for entering text
    */
    #include "gntwidget.h"
    --- a/gntfilesel.h Sat Apr 13 03:23:31 2019 -0400
    +++ b/gntfilesel.h Sat Apr 13 05:05:59 2019 -0400
    @@ -25,8 +25,8 @@
    /**
    * SECTION:gntfilesel
    * @section_id: libgnt-gntfilesel
    - * @short_description: <filename>gntfilesel.h</filename>
    - * @title: File Selector
    + * @title: GntFileSel
    + * @short_description: A widget for selecting a file or directory
    */
    #include "gntwindow.h"
    --- a/gntkeys.h Sat Apr 13 03:23:31 2019 -0400
    +++ b/gntkeys.h Sat Apr 13 05:05:59 2019 -0400
    @@ -25,8 +25,8 @@
    /**
    * SECTION:gntkeys
    * @section_id: libgnt-gntkeys
    - * @short_description: <filename>gntkeys.h</filename>
    - * @title: Keys API
    + * @title: Keys
    + * @short_description: Key value lookup and transformation
    */
    #include <term.h>
    --- a/gntlabel.h Sat Apr 13 03:23:31 2019 -0400
    +++ b/gntlabel.h Sat Apr 13 05:05:59 2019 -0400
    @@ -25,8 +25,8 @@
    /**
    * SECTION:gntlabel
    * @section_id: libgnt-gntlabel
    - * @short_description: <filename>gntlabel.h</filename>
    - * @title: Label
    + * @title: GntLabel
    + * @short_description: A widget that displays text
    */
    #include "gnt.h"
    --- a/gntline.h Sat Apr 13 03:23:31 2019 -0400
    +++ b/gntline.h Sat Apr 13 05:05:59 2019 -0400
    @@ -25,8 +25,8 @@
    /**
    * SECTION:gntline
    * @section_id: libgnt-gntline
    - * @short_description: <filename>gntline.h</filename>
    - * @title: Line
    + * @title: GntLine
    + * @short_description: A widget that draws a horizontal or vertical line
    */
    #include "gntwidget.h"
    --- a/gntmenu.h Sat Apr 13 03:23:31 2019 -0400
    +++ b/gntmenu.h Sat Apr 13 05:05:59 2019 -0400
    @@ -25,8 +25,9 @@
    /**
    * SECTION:gntmenu
    * @section_id: libgnt-gntmenu
    - * @short_description: <filename>gntmenu.h</filename>
    - * @title: Menu
    + * @title: GntMenu
    + * @short_description: A widget for a toplevel or popup menu
    + * @see_also: #GntMenuItem #GntMenuItemCheck
    */
    #include "gnttree.h"
    --- a/gntmenuitem.h Sat Apr 13 03:23:31 2019 -0400
    +++ b/gntmenuitem.h Sat Apr 13 05:05:59 2019 -0400
    @@ -25,8 +25,9 @@
    /**
    * SECTION:gntmenuitem
    * @section_id: libgnt-gntmenuitem
    - * @short_description: <filename>gntmenuitem.h</filename>
    - * @title: Menuitem
    + * @title: GntMenuItem
    + * @short_description: An item within a menu
    + * @see_also: #GntMenu #GntMenuItem
    */
    #include <glib.h>
    --- a/gntmenuitemcheck.h Sat Apr 13 03:23:31 2019 -0400
    +++ b/gntmenuitemcheck.h Sat Apr 13 05:05:59 2019 -0400
    @@ -25,8 +25,9 @@
    /**
    * SECTION:gntmenuitemcheck
    * @section_id: libgnt-gntmenuitemcheck
    - * @short_description: <filename>gntmenuitemcheck.h</filename>
    - * @title: Check Menuitem
    + * @title: GntMenuItemCheck
    + * @short_description: A menu item with a check box
    + * @see_also: #GntMenu #GntMenuItem
    */
    #include "gnt.h"
    --- a/gntprogressbar.h Sat Apr 13 03:23:31 2019 -0400
    +++ b/gntprogressbar.h Sat Apr 13 05:05:59 2019 -0400
    @@ -25,8 +25,8 @@
    /**
    * SECTION:gntprogressbar
    * @section_id: libgnt-gntprogressbar
    - * @short_description: <filename>gntprogressbar.h</filename>
    - * @title: Progress Bar
    + * @title: GntProgressBar
    + * @short_description: A widget that shows progress visually
    */
    #include "gnt.h"
    --- a/gntslider.h Sat Apr 13 03:23:31 2019 -0400
    +++ b/gntslider.h Sat Apr 13 05:05:59 2019 -0400
    @@ -25,8 +25,8 @@
    /**
    * SECTION:gntslider
    * @section_id: libgnt-gntslider
    - * @short_description: <filename>gntslider.h</filename>
    - * @title: Slider
    + * @title: GntSlider
    + * @short_description: A widget for selecting from a range of values
    */
    #include "gntwidget.h"
    --- a/gntstyle.h Sat Apr 13 03:23:31 2019 -0400
    +++ b/gntstyle.h Sat Apr 13 05:05:59 2019 -0400
    @@ -25,8 +25,8 @@
    /**
    * SECTION:gntstyle
    * @section_id: libgnt-gntstyle
    - * @short_description: <filename>gntstyle.h</filename>
    - * @title: Style API
    + * @title: Styles
    + * @short_description: Styling from a configuration file
    */
    #include "gnt.h"
    --- a/gnttextview.h Sat Apr 13 03:23:31 2019 -0400
    +++ b/gnttextview.h Sat Apr 13 05:05:59 2019 -0400
    @@ -25,8 +25,8 @@
    /**
    * SECTION:gnttextview
    * @section_id: libgnt-gnttextview
    - * @short_description: <filename>gnttextview.h</filename>
    - * @title: Textview
    + * @title: GntTextView
    + * @short_description: A widget for displaying larger bodies of formatted text
    */
    #include "gntwidget.h"
    --- a/gnttree.h Sat Apr 13 03:23:31 2019 -0400
    +++ b/gnttree.h Sat Apr 13 05:05:59 2019 -0400
    @@ -25,8 +25,8 @@
    /**
    * SECTION:gnttree
    * @section_id: libgnt-gnttree
    - * @short_description: <filename>gnttree.h</filename>
    - * @title: Tree
    + * @title: GntTree
    + * @short_description: A widget that shows a tree of items
    */
    #include "gntwidget.h"
    --- a/gntutils.h Sat Apr 13 03:23:31 2019 -0400
    +++ b/gntutils.h Sat Apr 13 05:05:59 2019 -0400
    @@ -25,8 +25,8 @@
    /**
    * SECTION:gntutils
    * @section_id: libgnt-gntutils
    - * @short_description: <filename>gntutils.h</filename>
    * @title: Utility functions
    + * @short_description: Various internal utility functions
    */
    #include <glib.h>
    --- a/gntversion.h.in Sat Apr 13 03:23:31 2019 -0400
    +++ b/gntversion.h.in Sat Apr 13 05:05:59 2019 -0400
    @@ -23,10 +23,10 @@
    #ifndef GNT_VERSION_H
    #define GNT_VERSION_H
    /**
    - * SECTION:gnt
    - * @section_id: libgnt-gnt
    - * @short_description: <filename>gntversion.h</filename>
    - * @title: GNT Versioning
    + * SECTION:gntversion
    + * @section_id: libgnt-gntversion
    + * @title: Version Information
    + * @short_description: Variables to check the GNT version
    */
    #mesondefine GNT_VERSION
    --- a/gntwidget.h Sat Apr 13 03:23:31 2019 -0400
    +++ b/gntwidget.h Sat Apr 13 05:05:59 2019 -0400
    @@ -25,8 +25,8 @@
    /**
    * SECTION:gntwidget
    * @section_id: libgnt-gntwidget
    - * @short_description: <filename>gntwidget.h</filename>
    - * @title: Widget
    + * @title: GntWidget
    + * @short_description: A general widget
    */
    #include <stdio.h>
    --- a/gntwindow.h Sat Apr 13 03:23:31 2019 -0400
    +++ b/gntwindow.h Sat Apr 13 05:05:59 2019 -0400
    @@ -25,8 +25,8 @@
    /**
    * SECTION:gntwindow
    * @section_id: libgnt-gntwindow
    - * @short_description: <filename>gntwindow.h</filename>
    - * @title: Window
    + * @title: GntWindow
    + * @short_description: A toplevel window
    */
    #include "gnt.h"
    --- a/gntwm.h Sat Apr 13 03:23:31 2019 -0400
    +++ b/gntwm.h Sat Apr 13 05:05:59 2019 -0400
    @@ -25,8 +25,8 @@
    /**
    * SECTION:gntwm
    * @section_id: libgnt-gntwm
    - * @short_description: <filename>gntwm.h</filename>
    - * @title: Window-manager API
    + * @title: GntWM
    + * @short_description: A window manager
    */
    #include "gntwidget.h"
    --- a/gntws.h Sat Apr 13 03:23:31 2019 -0400
    +++ b/gntws.h Sat Apr 13 05:05:59 2019 -0400
    @@ -25,8 +25,8 @@
    /**
    * SECTION:gntws
    * @section_id: libgnt-gntws
    - * @short_description: <filename>gntws.h</filename>
    - * @title: Workspace API
    + * @title: GntWS
    + * @short_description: Workspace API
    */
    #include "gntwidget.h"