qulogic/libgnt

Add sections for libgnt and re-arrange GNT doc index
gtkdoc-conversion
2014-02-04, Ankit Vani
e874c730f226
Parents 64c4b3d04cc1
Children 2e64e56b3af7
Add sections for libgnt and re-arrange GNT doc index
27 files changed, 162 insertions(+), 114 deletions(-)
  • +6 -4
    gnt-skel.h
  • +6 -10
    gnt.h
  • +6 -4
    gntbindable.h
  • +6 -4
    gntbox.h
  • +6 -4
    gntbutton.h
  • +6 -4
    gntcheckbox.h
  • +6 -4
    gntclipboard.h
  • +6 -4
    gntcolors.h
  • +6 -4
    gntcombobox.h
  • +6 -4
    gntentry.h
  • +6 -4
    gntfilesel.h
  • +6 -4
    gntkeys.h
  • +6 -4
    gntlabel.h
  • +6 -4
    gntline.h
  • +6 -4
    gntmenu.h
  • +6 -4
    gntmenuitem.h
  • +6 -4
    gntmenuitemcheck.h
  • +6 -4
    gntprogressbar.h
  • +6 -4
    gntslider.h
  • +6 -4
    gntstyle.h
  • +6 -4
    gnttextview.h
  • +6 -4
    gnttree.h
  • +6 -4
    gntutils.h
  • +6 -4
    gntwidget.h
  • +6 -4
    gntwindow.h
  • +6 -4
    gntwm.h
  • +6 -4
    gntws.h
    • --- a/gnt-skel.h Sun Feb 02 23:11:11 2014 +0530
    +++ b/gnt-skel.h Tue Feb 04 04:03:17 2014 +0530
    @@ -1,7 +1,3 @@
    -/**
    - * @file gnt-skel.h -skel API
    - * @ingroup gnt
    - */
    /*
    * GNT - The GLib Ncurses Toolkit
    *
    @@ -23,6 +19,12 @@
    * along with this program; if not, write to the Free Software
    * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
    */
    +/**
    + * SECTION:gnt-skel
    + * @section_id: libgnt-gnt-skel
    + * @short_description: <filename>gnt-skel.h</filename>
    + * @title: Skel API
    + */
    #ifndef GNT_SKEL_H
    #define GNT_SKEL_H
    --- a/gnt.h Sun Feb 02 23:11:11 2014 +0530
    +++ b/gnt.h Tue Feb 04 04:03:17 2014 +0530
    @@ -1,13 +1,3 @@
    -/**
    - * @defgroup gnt GNT (GLib Ncurses Toolkit)
    - *
    - * GNT is an ncurses toolkit for creating text-mode graphical user interfaces
    - * in a fast and easy way.
    - */
    -/**
    - * @file gnt.h GNT API
    - * @ingroup gnt
    - */
    /*
    * GNT - The GLib Ncurses Toolkit
    *
    @@ -29,6 +19,12 @@
    * along with this program; if not, write to the Free Software
    * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
    */
    +/**
    + * SECTION:gnt
    + * @section_id: libgnt-gnt
    + * @short_description: <filename>gnt.h</filename>
    + * @title: GNT API
    + */
    #ifndef GNT_H
    #define GNT_H
    --- a/gntbindable.h Sun Feb 02 23:11:11 2014 +0530
    +++ b/gntbindable.h Tue Feb 04 04:03:17 2014 +0530
    @@ -1,7 +1,3 @@
    -/**
    - * @file gntbindable.h Bindable API
    - * @ingroup gnt
    - */
    /*
    * GNT - The GLib Ncurses Toolkit
    *
    @@ -23,6 +19,12 @@
    * along with this program; if not, write to the Free Software
    * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
    */
    +/**
    + * SECTION:gntbindable
    + * @section_id: libgnt-gntbindable
    + * @short_description: <filename>gntbindable.h</filename>
    + * @title: Bindable
    + */
    #ifndef GNT_BINDABLE_H
    #define GNT_BINDABLE_H
    --- a/gntbox.h Sun Feb 02 23:11:11 2014 +0530
    +++ b/gntbox.h Tue Feb 04 04:03:17 2014 +0530
    @@ -1,7 +1,3 @@
    -/**
    - * @file gntbox.h Box API
    - * @ingroup gnt
    - */
    /*
    * GNT - The GLib Ncurses Toolkit
    *
    @@ -23,6 +19,12 @@
    * along with this program; if not, write to the Free Software
    * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
    */
    +/**
    + * SECTION:gntbox
    + * @section_id: libgnt-gntbox
    + * @short_description: <filename>gntbox.h</filename>
    + * @title: Box
    + */
    #ifndef GNT_BOX_H
    #define GNT_BOX_H
    --- a/gntbutton.h Sun Feb 02 23:11:11 2014 +0530
    +++ b/gntbutton.h Tue Feb 04 04:03:17 2014 +0530
    @@ -1,7 +1,3 @@
    -/**
    - * @file gntbutton.h Button API
    - * @ingroup gnt
    - */
    /*
    * GNT - The GLib Ncurses Toolkit
    *
    @@ -23,6 +19,12 @@
    * along with this program; if not, write to the Free Software
    * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
    */
    +/**
    + * SECTION:gntbutton
    + * @section_id: libgnt-gntbutton
    + * @short_description: <filename>gntbutton.h</filename>
    + * @title: Button
    + */
    #ifndef GNT_BUTTON_H
    #define GNT_BUTTON_H
    --- a/gntcheckbox.h Sun Feb 02 23:11:11 2014 +0530
    +++ b/gntcheckbox.h Tue Feb 04 04:03:17 2014 +0530
    @@ -1,7 +1,3 @@
    -/**
    - * @file gntcheckbox.h Checkbox API
    - * @ingroup gnt
    - */
    /*
    * GNT - The GLib Ncurses Toolkit
    *
    @@ -23,6 +19,12 @@
    * along with this program; if not, write to the Free Software
    * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
    */
    +/**
    + * SECTION:gntcheckbox
    + * @section_id: libgnt-gntcheckbox
    + * @short_description: <filename>gntcheckbox.h</filename>
    + * @title: Checkbox
    + */
    #ifndef GNT_CHECK_BOX_H
    #define GNT_CHECK_BOX_H
    --- a/gntclipboard.h Sun Feb 02 23:11:11 2014 +0530
    +++ b/gntclipboard.h Tue Feb 04 04:03:17 2014 +0530
    @@ -1,7 +1,3 @@
    -/**
    - * @file gntclipboard.h Clipboard API
    - * @ingroup gnt
    - */
    /*
    * GNT - The GLib Ncurses Toolkit
    *
    @@ -23,6 +19,12 @@
    * along with this program; if not, write to the Free Software
    * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
    */
    +/**
    + * SECTION:gntclipboard
    + * @section_id: libgnt-gntclipboard
    + * @short_description: <filename>gntclipboard.h</filename>
    + * @title: Clipboard
    + */
    #ifndef GNT_CLIPBOARD_H
    #define GNT_CLIPBOARD_H
    --- a/gntcolors.h Sun Feb 02 23:11:11 2014 +0530
    +++ b/gntcolors.h Tue Feb 04 04:03:17 2014 +0530
    @@ -1,7 +1,3 @@
    -/**
    - * @file gntcolors.h Colors API
    - * @ingroup gnt
    - */
    /*
    * GNT - The GLib Ncurses Toolkit
    *
    @@ -23,6 +19,12 @@
    * along with this program; if not, write to the Free Software
    * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
    */
    +/**
    + * SECTION:gntcolors
    + * @section_id: libgnt-gntcolors
    + * @short_description: <filename>gntcolors.h</filename>
    + * @title: Colors
    + */
    #ifndef GNT_COLORS_H
    #define GNT_COLORS_H
    --- a/gntcombobox.h Sun Feb 02 23:11:11 2014 +0530
    +++ b/gntcombobox.h Tue Feb 04 04:03:17 2014 +0530
    @@ -1,7 +1,3 @@
    -/**
    - * @file gntcombobox.h Combobox API
    - * @ingroup gnt
    - */
    /*
    * GNT - The GLib Ncurses Toolkit
    *
    @@ -23,6 +19,12 @@
    * along with this program; if not, write to the Free Software
    * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
    */
    +/**
    + * SECTION:gntcombobox
    + * @section_id: libgnt-gntcombobox
    + * @short_description: <filename>gntcombobox.h</filename>
    + * @title: Combobox
    + */
    #ifndef GNT_COMBO_BOX_H
    #define GNT_COMBO_BOX_H
    --- a/gntentry.h Sun Feb 02 23:11:11 2014 +0530
    +++ b/gntentry.h Tue Feb 04 04:03:17 2014 +0530
    @@ -1,7 +1,3 @@
    -/**
    - * @file gntentry.h Entry API
    - * @ingroup gnt
    - */
    /*
    * GNT - The GLib Ncurses Toolkit
    *
    @@ -23,6 +19,12 @@
    * along with this program; if not, write to the Free Software
    * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
    */
    +/**
    + * SECTION:gntentry
    + * @section_id: libgnt-gntentry
    + * @short_description: <filename>gntentry.h</filename>
    + * @title: Entry
    + */
    #ifndef GNT_ENTRY_H
    #define GNT_ENTRY_H
    --- a/gntfilesel.h Sun Feb 02 23:11:11 2014 +0530
    +++ b/gntfilesel.h Tue Feb 04 04:03:17 2014 +0530
    @@ -1,7 +1,3 @@
    -/**
    - * @file gntfilesel.h File selector API
    - * @ingroup gnt
    - */
    /*
    * GNT - The GLib Ncurses Toolkit
    *
    @@ -23,6 +19,12 @@
    * along with this program; if not, write to the Free Software
    * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
    */
    +/**
    + * SECTION:gntfilesel
    + * @section_id: libgnt-gntfilesel
    + * @short_description: <filename>gntfilesel.h</filename>
    + * @title: File Selector
    + */
    #ifndef GNT_FILE_SEL_H
    #define GNT_FILE_SEL_H
    --- a/gntkeys.h Sun Feb 02 23:11:11 2014 +0530
    +++ b/gntkeys.h Tue Feb 04 04:03:17 2014 +0530
    @@ -1,7 +1,3 @@
    -/**
    - * @file gntkeys.h Keys API
    - * @ingroup gnt
    - */
    /*
    * GNT - The GLib Ncurses Toolkit
    *
    @@ -23,6 +19,12 @@
    * along with this program; if not, write to the Free Software
    * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
    */
    +/**
    + * SECTION:gntkeys
    + * @section_id: libgnt-gntkeys
    + * @short_description: <filename>gntkeys.h</filename>
    + * @title: Keys API
    + */
    #ifndef GNT_KEYS_H
    #define GNT_KEYS_H
    --- a/gntlabel.h Sun Feb 02 23:11:11 2014 +0530
    +++ b/gntlabel.h Tue Feb 04 04:03:17 2014 +0530
    @@ -1,7 +1,3 @@
    -/**
    - * @file gntlabel.h Label API
    - * @ingroup gnt
    - */
    /*
    * GNT - The GLib Ncurses Toolkit
    *
    @@ -23,6 +19,12 @@
    * along with this program; if not, write to the Free Software
    * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
    */
    +/**
    + * SECTION:gntlabel
    + * @section_id: libgnt-gntlabel
    + * @short_description: <filename>gntlabel.h</filename>
    + * @title: Label
    + */
    #ifndef GNT_LABEL_H
    #define GNT_LABEL_H
    --- a/gntline.h Sun Feb 02 23:11:11 2014 +0530
    +++ b/gntline.h Tue Feb 04 04:03:17 2014 +0530
    @@ -1,7 +1,3 @@
    -/**
    - * @file gntline.h Line API
    - * @ingroup gnt
    - */
    /*
    * GNT - The GLib Ncurses Toolkit
    *
    @@ -23,6 +19,12 @@
    * along with this program; if not, write to the Free Software
    * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
    */
    +/**
    + * SECTION:gntline
    + * @section_id: libgnt-gntline
    + * @short_description: <filename>gntline.h</filename>
    + * @title: Line
    + */
    #ifndef GNT_LINE_H
    #define GNT_LINE_H
    --- a/gntmenu.h Sun Feb 02 23:11:11 2014 +0530
    +++ b/gntmenu.h Tue Feb 04 04:03:17 2014 +0530
    @@ -1,7 +1,3 @@
    -/**
    - * @file gntmenu.h Menu API
    - * @ingroup gnt
    - */
    /*
    * GNT - The GLib Ncurses Toolkit
    *
    @@ -23,6 +19,12 @@
    * along with this program; if not, write to the Free Software
    * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
    */
    +/**
    + * SECTION:gntmenu
    + * @section_id: libgnt-gntmenu
    + * @short_description: <filename>gntmenu.h</filename>
    + * @title: Menu
    + */
    #ifndef GNT_MENU_H
    #define GNT_MENU_H
    --- a/gntmenuitem.h Sun Feb 02 23:11:11 2014 +0530
    +++ b/gntmenuitem.h Tue Feb 04 04:03:17 2014 +0530
    @@ -1,7 +1,3 @@
    -/**
    - * @file gntmenuitem.h Menuitem API
    - * @ingroup gnt
    - */
    /*
    * GNT - The GLib Ncurses Toolkit
    *
    @@ -23,6 +19,12 @@
    * along with this program; if not, write to the Free Software
    * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
    */
    +/**
    + * SECTION:gntmenuitem
    + * @section_id: libgnt-gntmenuitem
    + * @short_description: <filename>gntmenuitem.h</filename>
    + * @title: Menuitem
    + */
    #ifndef GNT_MENUITEM_H
    #define GNT_MENUITEM_H
    --- a/gntmenuitemcheck.h Sun Feb 02 23:11:11 2014 +0530
    +++ b/gntmenuitemcheck.h Tue Feb 04 04:03:17 2014 +0530
    @@ -1,7 +1,3 @@
    -/**
    - * @file gntmenuitemcheck.h Check Menuitem API
    - * @ingroup gnt
    - */
    /*
    * GNT - The GLib Ncurses Toolkit
    *
    @@ -23,6 +19,12 @@
    * along with this program; if not, write to the Free Software
    * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
    */
    +/**
    + * SECTION:gntmenuitemcheck
    + * @section_id: libgnt-gntmenuitemcheck
    + * @short_description: <filename>gntmenuitemcheck.h</filename>
    + * @title: Check Menuitem
    + */
    #ifndef GNT_MENU_ITEM_CHECK_H
    #define GNT_MENU_ITEM_CHECK_H
    --- a/gntprogressbar.h Sun Feb 02 23:11:11 2014 +0530
    +++ b/gntprogressbar.h Tue Feb 04 04:03:17 2014 +0530
    @@ -1,7 +1,3 @@
    -/**
    - * @file gntprogressbar.h Progress Bar API
    - * @ingroup gnt
    - */
    /*
    * GNT - The GLib Ncurses Toolkit
    *
    @@ -23,6 +19,12 @@
    * along with this program; if not, write to the Free Software
    * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
    */
    +/**
    + * SECTION:gntprogressbar
    + * @section_id: libgnt-gntprogressbar
    + * @short_description: <filename>gntprogressbar.h</filename>
    + * @title: Progress Bar
    + */
    #ifndef GNT_PROGRESS_BAR_H
    #define GNT_PROGRESS_BAR_H
    --- a/gntslider.h Sun Feb 02 23:11:11 2014 +0530
    +++ b/gntslider.h Tue Feb 04 04:03:17 2014 +0530
    @@ -1,7 +1,3 @@
    -/**
    - * @file gntslider.h Slider API
    - * @ingroup gnt
    - */
    /*
    * GNT - The GLib Ncurses Toolkit
    *
    @@ -23,6 +19,12 @@
    * along with this program; if not, write to the Free Software
    * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
    */
    +/**
    + * SECTION:gntslider
    + * @section_id: libgnt-gntslider
    + * @short_description: <filename>gntslider.h</filename>
    + * @title: Slider
    + */
    #ifndef GNT_SLIDER_H
    #define GNT_SLIDER_H
    --- a/gntstyle.h Sun Feb 02 23:11:11 2014 +0530
    +++ b/gntstyle.h Tue Feb 04 04:03:17 2014 +0530
    @@ -1,7 +1,3 @@
    -/**
    - * @file gntstyle.h Style API
    - * @ingroup gnt
    - */
    /*
    * GNT - The GLib Ncurses Toolkit
    *
    @@ -23,6 +19,12 @@
    * along with this program; if not, write to the Free Software
    * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
    */
    +/**
    + * SECTION:gntstyle
    + * @section_id: libgnt-gntstyle
    + * @short_description: <filename>gntstyle.h</filename>
    + * @title: Style API
    + */
    #include "gnt.h"
    #include "gntwm.h"
    --- a/gnttextview.h Sun Feb 02 23:11:11 2014 +0530
    +++ b/gnttextview.h Tue Feb 04 04:03:17 2014 +0530
    @@ -1,7 +1,3 @@
    -/**
    - * @file gnttextview.h Textview API
    - * @ingroup gnt
    - */
    /*
    * GNT - The GLib Ncurses Toolkit
    *
    @@ -23,6 +19,12 @@
    * along with this program; if not, write to the Free Software
    * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
    */
    +/**
    + * SECTION:gnttextview
    + * @section_id: libgnt-gnttextview
    + * @short_description: <filename>gnttextview.h</filename>
    + * @title: Textview
    + */
    #ifndef GNT_TEXT_VIEW_H
    #define GNT_TEXT_VIEW_H
    --- a/gnttree.h Sun Feb 02 23:11:11 2014 +0530
    +++ b/gnttree.h Tue Feb 04 04:03:17 2014 +0530
    @@ -1,7 +1,3 @@
    -/**
    - * @file gnttree.h Tree API
    - * @ingroup gnt
    - */
    /*
    * GNT - The GLib Ncurses Toolkit
    *
    @@ -23,6 +19,12 @@
    * along with this program; if not, write to the Free Software
    * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
    */
    +/**
    + * SECTION:gnttree
    + * @section_id: libgnt-gnttree
    + * @short_description: <filename>gnttree.h</filename>
    + * @title: Tree
    + */
    #ifndef GNT_TREE_H
    #define GNT_TREE_H
    --- a/gntutils.h Sun Feb 02 23:11:11 2014 +0530
    +++ b/gntutils.h Tue Feb 04 04:03:17 2014 +0530
    @@ -1,7 +1,3 @@
    -/**
    - * @file gntutils.h Some utility functions
    - * @ingroup gnt
    - */
    /*
    * GNT - The GLib Ncurses Toolkit
    *
    @@ -23,6 +19,12 @@
    * along with this program; if not, write to the Free Software
    * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
    */
    +/**
    + * SECTION:gntutils
    + * @section_id: libgnt-gntutils
    + * @short_description: <filename>gntutils.h</filename>
    + * @title: Utility functions
    + */
    #include <glib.h>
    --- a/gntwidget.h Sun Feb 02 23:11:11 2014 +0530
    +++ b/gntwidget.h Tue Feb 04 04:03:17 2014 +0530
    @@ -1,7 +1,3 @@
    -/**
    - * @file gntwidget.h Widget API
    - * @ingroup gnt
    - */
    /*
    * GNT - The GLib Ncurses Toolkit
    *
    @@ -23,6 +19,12 @@
    * along with this program; if not, write to the Free Software
    * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
    */
    +/**
    + * SECTION:gntwidget
    + * @section_id: libgnt-gntwidget
    + * @short_description: <filename>gntwidget.h</filename>
    + * @title: Widget
    + */
    #ifndef GNT_WIDGET_H
    #define GNT_WIDGET_H
    --- a/gntwindow.h Sun Feb 02 23:11:11 2014 +0530
    +++ b/gntwindow.h Tue Feb 04 04:03:17 2014 +0530
    @@ -1,7 +1,3 @@
    -/**
    - * @file gntwindow.h Window API
    - * @ingroup gnt
    - */
    /*
    * GNT - The GLib Ncurses Toolkit
    *
    @@ -23,6 +19,12 @@
    * along with this program; if not, write to the Free Software
    * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
    */
    +/**
    + * SECTION:gntwindow
    + * @section_id: libgnt-gntwindow
    + * @short_description: <filename>gntwindow.h</filename>
    + * @title: Window
    + */
    #ifndef GNT_WINDOW_H
    #define GNT_WINDOW_H
    --- a/gntwm.h Sun Feb 02 23:11:11 2014 +0530
    +++ b/gntwm.h Tue Feb 04 04:03:17 2014 +0530
    @@ -1,7 +1,3 @@
    -/**
    - * @file gntwm.h Window-manager API
    - * @ingroup gnt
    - */
    /*
    * GNT - The GLib Ncurses Toolkit
    *
    @@ -23,6 +19,12 @@
    * along with this program; if not, write to the Free Software
    * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
    */
    +/**
    + * SECTION:gntwm
    + * @section_id: libgnt-gntwm
    + * @short_description: <filename>gntwm.h</filename>
    + * @title: Window-manager API
    + */
    #ifndef GNTWM_H
    #define GNTWM_H
    --- a/gntws.h Sun Feb 02 23:11:11 2014 +0530
    +++ b/gntws.h Tue Feb 04 04:03:17 2014 +0530
    @@ -1,7 +1,3 @@
    -/**
    - * @file gntws.h Workspace API
    - * @ingroup gnt
    - */
    /*
    * GNT - The GLib Ncurses Toolkit
    *
    @@ -23,6 +19,12 @@
    * along with this program; if not, write to the Free Software
    * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
    */
    +/**
    + * SECTION:gntws
    + * @section_id: libgnt-gntws
    + * @short_description: <filename>gntws.h</filename>
    + * @title: Workspace API
    + */
    #ifndef GNTWS_H
    #define GNTWS_H