qulogic/libgnt

Add docs for shortcut macros.

2019-08-28, Elliott Sales de Andrade
1d54c0fddb2c
Parents 9d5cd9fa79d1
Children 30bca5cf8435
Add docs for shortcut macros.
4 files changed, 88 insertions(+), 12 deletions(-)
  • +22 -5
    gntbox.h
  • +18 -2
    gntline.h
  • +28 -4
    gntslider.h
  • +20 -1
    gntwindow.h
    • --- a/gntbox.h Wed Aug 28 16:44:51 2019 -0400
    +++ b/gntbox.h Wed Aug 28 17:25:18 2019 -0400
    @@ -86,19 +86,36 @@
    */
    G_DECLARE_DERIVABLE_TYPE(GntBox, gnt_box, GNT, BOX, GntWidget)
    +/**
    + * gnt_hbox_new:
    + * @homogeneous: If %TRUE, all the widgets in it will have the same width.
    + *
    + * Create a new horizontal box.
    + *
    + * Returns: The new box.
    + */
    +#define gnt_hbox_new(homogeneous) gnt_box_new(homogeneous, FALSE)
    +
    +/**
    + * gnt_vbox_new:
    + * @homogeneous: If %TRUE, all the widgets in it will have the same height.
    + *
    + * Create a new vertical box.
    + *
    + * Returns: The new box.
    + */
    #define gnt_vbox_new(homogeneous) gnt_box_new(homogeneous, TRUE)
    -#define gnt_hbox_new(homogeneous) gnt_box_new(homogeneous, FALSE)
    /**
    * gnt_box_new:
    - * @homogeneous: If %TRUE, all the widgets in it will have the same width (or
    - * height)
    + * @homogeneous: If %TRUE, all the widgets in it will have the same height (or
    + * width).
    * @vert: Whether the widgets in it should be stacked vertically (if %TRUE) or
    * horizontally (if %FALSE).
    *
    - * Create a new GntBox.
    + * Create a new box.
    *
    - * Returns: The new GntBox.
    + * Returns: The new box.
    */
    GntWidget *gnt_box_new(gboolean homogeneous, gboolean vert);
    --- a/gntline.h Wed Aug 28 16:44:51 2019 -0400
    +++ b/gntline.h Wed Aug 28 17:25:18 2019 -0400
    @@ -45,14 +45,30 @@
    */
    G_DECLARE_FINAL_TYPE(GntLine, gnt_line, GNT, LINE, GntWidget)
    +/**
    + * gnt_hline_new:
    + *
    + * Create new horizontal line.
    + *
    + * Returns: The newly created line.
    + */
    #define gnt_hline_new() gnt_line_new(FALSE)
    +
    +/**
    + * gnt_vline_new:
    + *
    + * Create new vertical line.
    + *
    + * Returns: The newly created line.
    + */
    #define gnt_vline_new() gnt_line_new(TRUE)
    /**
    * gnt_line_new:
    - * @vertical: %TRUE if the line should be vertical, %FALSE for a horizontal line.
    + * @vertical: %TRUE if the line should be vertical, %FALSE for a horizontal
    + * line.
    *
    - * Create new line
    + * Create new line.
    *
    * Returns: The newly created line.
    */
    --- a/gntslider.h Wed Aug 28 16:44:51 2019 -0400
    +++ b/gntslider.h Wed Aug 28 17:25:18 2019 -0400
    @@ -66,18 +66,42 @@
    gpointer reserved[4];
    };
    +/**
    + * gnt_hslider_new:
    + * @max: The maximum value for the slider.
    + * @min: The minimum value for the slider.
    + *
    + * Create a new horizontal slider.
    + *
    + * Returns: The newly created slider.
    + *
    + * Since: 2.1.0
    + */
    #define gnt_hslider_new(max, min) gnt_slider_new(FALSE, max, min)
    +
    +/**
    + * gnt_vslider_new:
    + * @max: The maximum value for the slider.
    + * @min: The minimum value for the slider.
    + *
    + * Create a new vertical slider.
    + *
    + * Returns: The newly created slider.
    + *
    + * Since: 2.1.0
    + */
    #define gnt_vslider_new(max, min) gnt_slider_new(TRUE, max, min)
    /**
    * gnt_slider_new:
    - * @orient: A vertical slider is created if %TRUE, otherwise the slider is horizontal.
    - * @max: The maximum value for the slider
    - * @min: The minimum value for the slider
    + * @orient: A vertical slider is created if %TRUE, otherwise the slider is
    + * horizontal.
    + * @max: The maximum value for the slider.
    + * @min: The minimum value for the slider.
    *
    * Create a new slider.
    *
    - * Returns: The newly created slider
    + * Returns: The newly created slider.
    *
    * Since: 2.1.0
    */
    --- a/gntwindow.h Wed Aug 28 16:44:51 2019 -0400
    +++ b/gntwindow.h Wed Aug 28 17:25:18 2019 -0400
    @@ -75,8 +75,27 @@
    */
    G_DECLARE_DERIVABLE_TYPE(GntWindow, gnt_window, GNT, WINDOW, GntBox)
    +/**
    + * gnt_hwindow_new:
    + * @homogeneous: %TRUE if the widgets inside the window should have the same
    + * dimensions.
    + *
    + * Create a new window with widgets stacked horizontally.
    + *
    + * Returns: The newly created window.
    + */
    +#define gnt_hwindow_new(homogeneous) gnt_window_box_new(homogeneous, FALSE)
    +
    +/**
    + * gnt_vwindow_new:
    + * @homogeneous: %TRUE if the widgets inside the window should have the same
    + * dimensions.
    + *
    + * Create a new window with widgets stacked vertically.
    + *
    + * Returns: The newly created window.
    + */
    #define gnt_vwindow_new(homogeneous) gnt_window_box_new(homogeneous, TRUE)
    -#define gnt_hwindow_new(homogeneous) gnt_window_box_new(homogeneous, FALSE)
    /**
    * gnt_window_new: