qulogic/libgnt

Add missing docs for enumerations.

2019-05-13, Elliott Sales de Andrade
defbeb30636f
Parents 1560f38da91e
Children 567948b95e50
Add missing docs for enumerations.
8 files changed, 118 insertions(+), 12 deletions(-)
  • +14 -0
    gntbox.h
  • +23 -5
    gntcolors.h
  • +20 -5
    gntentry.h
  • +9 -0
    gntprogressbar.h
  • +12 -0
    gntstyle.h
  • +19 -2
    gnttextview.h
  • +12 -0
    gntwidget.h
  • +9 -0
    gntwindow.h
    • --- a/gntbox.h Sat May 11 01:41:03 2019 -0400
    +++ b/gntbox.h Mon May 13 22:25:57 2019 -0400
    @@ -34,6 +34,20 @@
    #define GNT_TYPE_BOX gnt_box_get_type()
    +/**
    + * GntAlignment:
    + * @GNT_ALIGN_LEFT: Align to the left. Applicable to vertically-oriented boxes
    + * only.
    + * @GNT_ALIGN_RIGHT: Align to the right. Applicable to vertically-oriented
    + * boxes only.
    + * @GNT_ALIGN_MID: Align to the middle. Applies to either orientation.
    + * @GNT_ALIGN_TOP: Align to the top. Applicable to horizontally-oriented boxes
    + * only.
    + * @GNT_ALIGN_BOTTOM: Align to the bottom. Applicable to horizontally-oriented
    + * boxes only.
    + *
    + * Alignment of contents of #GntBox widgets.
    + */
    typedef enum
    {
    /* These for vertical boxes */
    --- a/gntcolors.h Sat May 11 01:41:03 2019 -0400
    +++ b/gntcolors.h Mon May 13 22:25:57 2019 -0400
    @@ -33,23 +33,41 @@
    /**
    * GntColorType:
    + * @GNT_COLOR_NORMAL: The normal widget background color.
    + * @GNT_COLOR_HIGHLIGHT: The widget background color for highlighting, e.g.,
    + * when a button is selected.
    + * @GNT_COLOR_DISABLED: The background color for disabled widgets.
    + * @GNT_COLOR_HIGHLIGHT_D: The color for selected widgets, in windows without
    + * focus.
    + * @GNT_COLOR_TEXT_NORMAL: The color of text in an entry.
    + * @GNT_COLOR_TEXT_INACTIVE: The color of text when the entry is out of focus.
    + * @GNT_COLOR_MNEMONIC: The color of a mnemonic character. Unused.
    + * @GNT_COLOR_MNEMONIC_D: The color of a mnemonic character for a widget
    + * without focus. Unused.
    + * @GNT_COLOR_SHADOW: The color of a widget shadow.
    + * @GNT_COLOR_TITLE: The color of the title of a window or box.
    + * @GNT_COLOR_TITLE_D: The color of the title of a window or box that is out of
    + * focus.
    + * @GNT_COLOR_URGENT: This is for the 'urgent' windows.
    + * @GNT_COLORS: A count of the number of colors. Custom color types start from
    + * this value.
    *
    * Different classes of colors.
    */
    typedef enum
    {
    GNT_COLOR_NORMAL = 1,
    - GNT_COLOR_HIGHLIGHT, /* eg. when a button is selected */
    - GNT_COLOR_DISABLED, /* eg. when a button is disabled */
    - GNT_COLOR_HIGHLIGHT_D, /* eg. when a button is selected, but some other window is in focus */
    + GNT_COLOR_HIGHLIGHT,
    + GNT_COLOR_DISABLED,
    + GNT_COLOR_HIGHLIGHT_D,
    GNT_COLOR_TEXT_NORMAL,
    - GNT_COLOR_TEXT_INACTIVE, /* when the entry is out of focus */
    + GNT_COLOR_TEXT_INACTIVE,
    GNT_COLOR_MNEMONIC,
    GNT_COLOR_MNEMONIC_D,
    GNT_COLOR_SHADOW,
    GNT_COLOR_TITLE,
    GNT_COLOR_TITLE_D,
    - GNT_COLOR_URGENT, /* this is for the 'urgent' windows */
    + GNT_COLOR_URGENT,
    GNT_COLORS
    } GntColorType;
    --- a/gntentry.h Sat May 11 01:41:03 2019 -0400
    +++ b/gntentry.h Mon May 13 22:25:57 2019 -0400
    @@ -38,15 +38,30 @@
    #define GNT_ENTRY_CHAR '_' /* The character to use to fill in the blank places */
    +/**
    + * GntEntryFlag:
    + * @GNT_ENTRY_FLAG_ALPHA: Alphabetical characters are allowed.
    + * @GNT_ENTRY_FLAG_INT: Digit characters are allowed.
    + * @GNT_ENTRY_FLAG_NO_SPACE: No whitespace is allowed.
    + * @GNT_ENTRY_FLAG_NO_PUNCT: No punctuation is allowed.
    + * @GNT_ENTRY_FLAG_MASK: Mask the characters in the input display.
    + *
    + * Flags that control the behaviour of a #GntEntry.
    + */
    typedef enum
    {
    - GNT_ENTRY_FLAG_ALPHA = 1 << 0, /* Only alpha */
    - GNT_ENTRY_FLAG_INT = 1 << 1, /* Only integer */
    - GNT_ENTRY_FLAG_NO_SPACE = 1 << 2, /* No blank space is allowed */
    - GNT_ENTRY_FLAG_NO_PUNCT = 1 << 3, /* No punctuations */
    - GNT_ENTRY_FLAG_MASK = 1 << 4, /* Mask the inputs */
    + GNT_ENTRY_FLAG_ALPHA = 1 << 0,
    + GNT_ENTRY_FLAG_INT = 1 << 1,
    + GNT_ENTRY_FLAG_NO_SPACE = 1 << 2,
    + GNT_ENTRY_FLAG_NO_PUNCT = 1 << 3,
    + GNT_ENTRY_FLAG_MASK = 1 << 4,
    } GntEntryFlag;
    +/**
    + * GNT_ENTRY_FLAG_ALL:
    + *
    + * Allow all characters in a #GntEntry.
    + */
    #define GNT_ENTRY_FLAG_ALL (GNT_ENTRY_FLAG_ALPHA | GNT_ENTRY_FLAG_INT)
    G_BEGIN_DECLS
    --- a/gntprogressbar.h Sat May 11 01:41:03 2019 -0400
    +++ b/gntprogressbar.h Mon May 13 22:25:57 2019 -0400
    @@ -34,6 +34,15 @@
    #define GNT_TYPE_PROGRESS_BAR (gnt_progress_bar_get_type ())
    +/**
    + * GntProgressBarOrientation:
    + * @GNT_PROGRESS_LEFT_TO_RIGHT: The progress bar fills from left to right.
    + * @GNT_PROGRESS_RIGHT_TO_LEFT: The progress bar fills from right to left.
    + * @GNT_PROGRESS_BOTTOM_TO_TOP: The progress bar fills from bottom to top.
    + * @GNT_PROGRESS_TOP_TO_BOTTOM: The progress bar fills from top to bottom.
    + *
    + * The orientation of a #GntProgressBar.
    + */
    typedef enum
    {
    GNT_PROGRESS_LEFT_TO_RIGHT,
    --- a/gntstyle.h Sat May 11 01:41:03 2019 -0400
    +++ b/gntstyle.h Mon May 13 22:25:57 2019 -0400
    @@ -32,6 +32,18 @@
    #include "gnt.h"
    #include "gntwm.h"
    +/**
    + * GntStyle:
    + * @GNT_STYLE_SHADOW: Whether to show a shadow. Boolean.
    + * @GNT_STYLE_COLOR: Whether to show colors. Boolean.
    + * @GNT_STYLE_MOUSE: Whether to enable the mouse. Boolean.
    + * @GNT_STYLE_WM: Which window manager to use. String.
    + * @GNT_STYLE_REMPOS: Whether to remember the positions of windows. Boolean.
    + * @GNT_STYLES: The number of style settings.
    + *
    + * The type of style that a user might set. For boolean options, use
    + * gnt_style_get_bool(). For string options, use gnt_style_get().
    + */
    typedef enum
    {
    GNT_STYLE_SHADOW = 0,
    --- a/gnttextview.h Sat May 11 01:41:03 2019 -0400
    +++ b/gnttextview.h Mon May 13 22:25:57 2019 -0400
    @@ -38,6 +38,11 @@
    /**
    * GntTextViewFlag:
    + * @GNT_TEXT_VIEW_NO_SCROLL: Do not add a scrollbar to the view.
    + * @GNT_TEXT_VIEW_WRAP_CHAR: Wrap on characters (instead of words).
    + * @GNT_TEXT_VIEW_TOP_ALIGN: Align text to the top of the view. Since: 2.1.1
    + *
    + * Flags that determine the behaviour of a #GntTextView.
    *
    * Since: 2.1.0
    */
    @@ -45,9 +50,21 @@
    {
    GNT_TEXT_VIEW_NO_SCROLL = 1 << 0,
    GNT_TEXT_VIEW_WRAP_CHAR = 1 << 1,
    - GNT_TEXT_VIEW_TOP_ALIGN = 1 << 2, /* Since: 2.1.1 */
    + GNT_TEXT_VIEW_TOP_ALIGN = 1 << 2,
    } GntTextViewFlag;
    +/**
    + * GntTextFormatFlags:
    + * @GNT_TEXT_FLAG_NORMAL: Display the text normally.
    + * @GNT_TEXT_FLAG_BOLD: Display the text in bold text.
    + * @GNT_TEXT_FLAG_UNDERLINE: Display the text with underlining.
    + * @GNT_TEXT_FLAG_BLINK: Display the text with blinking.
    + * @GNT_TEXT_FLAG_DIM: Display the text dimmed.
    + * @GNT_TEXT_FLAG_HIGHLIGHT: Display the text with highlighting.
    + *
    + * Flags that determine the display style of portions of text in a
    + * #GntTextView.
    + */
    typedef enum
    {
    GNT_TEXT_FLAG_NORMAL = 0,
    @@ -234,7 +251,7 @@
    * @view: The textview widget
    * @flag: The flag to set
    *
    - * Set a GntTextViewFlag for the textview widget.
    + * Set a #GntTextViewFlag for the textview widget.
    *
    * Since: 2.1.0
    */
    --- a/gntwidget.h Sat May 11 01:41:03 2019 -0400
    +++ b/gntwidget.h Mon May 13 22:25:57 2019 -0400
    @@ -35,6 +35,18 @@
    #include "gntbindable.h"
    /* XXX: This will probably move elsewhere */
    +/**
    + * GntMouseEvent:
    + * @GNT_LEFT_MOUSE_DOWN: A press of the left (primary) button.
    + * @GNT_MIDDLE_MOUSE_DOWN: A press of the middle (secondary) button.
    + * @GNT_RIGHT_MOUSE_DOWN: A press of the right (tertiary) button.
    + * @GNT_MOUSE_UP: A release of a mouse button.
    + * @GNT_MOUSE_SCROLL_UP: A scroll of the mouse wheel up.
    + * @GNT_MOUSE_SCROLL_DOWN: A scroll of the mouse wheel down.
    + *
    + * The type of a mouse event, used in gnt_widget_clicked() and the
    + * #GntWidget::clicked signal.
    + */
    typedef enum
    {
    GNT_LEFT_MOUSE_DOWN = 1,
    --- a/gntwindow.h Sat May 11 01:41:03 2019 -0400
    +++ b/gntwindow.h Mon May 13 22:25:57 2019 -0400
    @@ -37,6 +37,15 @@
    #define GNT_TYPE_WINDOW (gnt_window_get_type())
    +/**
    + * GntWindowFlags:
    + * @GNT_WINDOW_MAXIMIZE_X: The window size will be maximized in the
    + * x-direction.
    + * @GNT_WINDOW_MAXIMIZE_Y: The window size will be maximized in the
    + * y-direction.
    + *
    + * Flags indicating the maximization state of a #GntWindow.
    + */
    typedef enum
    {
    GNT_WINDOW_MAXIMIZE_X = 1 << 0,