diff options
author | Philip Chimento <philip@endlessm.com> | 2013-09-23 17:22:24 -0700 |
---|---|---|
committer | Philip Chimento <philip@endlessm.com> | 2013-09-23 17:24:06 -0700 |
commit | 7b24bdd011a10bf21275cd411738be459477bde9 (patch) | |
tree | 47453f5821bbb6a2d0ad08e2a77fe2e9c441c153 /endless | |
parent | 06ea5a4d6281b599f86fe0b86df6580e68600857 (diff) |
Fix doc tests
Add missing EosFlexyGrid documentation and fix a couple of cosmetic issues.
[endlessm/eos-sdk#313]
Diffstat (limited to 'endless')
-rw-r--r-- | endless/eosenums.h | 11 | ||||
-rw-r--r-- | endless/eosflexygrid.c | 2 | ||||
-rw-r--r-- | endless/eosflexygrid.h | 33 |
3 files changed, 45 insertions, 1 deletions
diff --git a/endless/eosenums.h b/endless/eosenums.h index 8d50f1b..d9b396a 100644 --- a/endless/eosenums.h +++ b/endless/eosenums.h @@ -42,6 +42,17 @@ typedef enum #define EOS_TYPE_FLEXY_SHAPE (eos_flexy_shape_get_type ()) +/** + * EosFlexyShape: + * @EOS_FLEXY_SHAPE_SMALL: 1x1 shape for small cells + * @EOS_FLEXY_SHAPE_MEDIUM_HORIZONTAL: 2x1 <quote>landscape</quote> shape for + * medium cells + * @EOS_FLEXY_SHAPE_MEDIUM_VERTICAL: 1x2 <quote>portrait</quote> shape for + * medium cells + * @EOS_FLEXY_SHAPE_LARGE: 2x2 shape for large cells + * + * Sizes for flexible-layout cells in `EosFlexyGrid`. + */ typedef enum { EOS_FLEXY_SHAPE_SMALL, diff --git a/endless/eosflexygrid.c b/endless/eosflexygrid.c index b695cc1..7e1d35e 100644 --- a/endless/eosflexygrid.c +++ b/endless/eosflexygrid.c @@ -2,7 +2,7 @@ /** * SECTION:flexy-grid - * @Title: EosFlexyGrid + * @Title: Flexible Grid * @Short_Description: A flexible grid layout manager * * The #EosFlexyGrid widget provides a grid of cells in a layout controlled diff --git a/endless/eosflexygrid.h b/endless/eosflexygrid.h index f1d9516..43ceca7 100644 --- a/endless/eosflexygrid.h +++ b/endless/eosflexygrid.h @@ -23,15 +23,48 @@ G_BEGIN_DECLS #define EOS_IS_FLEXY_GRID_CELL_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), EOS_TYPE_FLEXY_GRID_CELL)) #define EOS_FLEXY_GRID_CELL_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), EOS_TYPE_FLEXY_GRID_CELL, EosFlexyGridCellClass)) +/** + * EOS_STYLE_CLASS_FLEXY_GRID: + * + * A CSS class to match a grid with flexible layout, used by #EosFlexyGrid. + */ #define EOS_STYLE_CLASS_FLEXY_GRID "flexy-grid" +/** + * EOS_STYLE_CLASS_FLEXY_GRID_CELL: + * + * A CSS class to match a cell inside a grid with flexible layout, used by + * #EosFlexyGrid. + */ #define EOS_STYLE_CLASS_FLEXY_GRID_CELL "flexy-grid-cell" +/** + * EosFlexyGrid: + * + * This structure contains no public members. + */ typedef struct _EosFlexyGrid EosFlexyGrid; typedef struct _EosFlexyGridClass EosFlexyGridClass; +/** + * EosFlexyGridCell: + * + * This structure contains no public members. + */ typedef struct _EosFlexyGridCell EosFlexyGridCell; typedef struct _EosFlexyGridCellClass EosFlexyGridCellClass; +/** + * EosFlexyGridSortFunc: + * @cell_a: first cell to compare + * @cell_b: second cell to compare + * @user_data: data passed to eos_flexy_grid_set_sort_func() + * + * Type for functions that determine the sort order of two cells inside the + * grid. + * + * Returns: -1 if @cell_a should come before @cell_b, 1 if @cell_a should come + * after @cell_b, or 0 if @cell_a and @cell_b are identical. + */ typedef gint (* EosFlexyGridSortFunc) (EosFlexyGridCell *cell_a, EosFlexyGridCell *cell_b, gpointer user_data); |