From e68b48fb6e2c34fc0097669ba3a85b04ceb1d618 Mon Sep 17 00:00:00 2001 From: Miguel de Icaza Date: Sat, 9 Dec 2000 02:18:00 +0000 Subject: Work to get a Gtk-Doc infrastructure in place for Gal. Work to get a Gtk-Doc infrastructure in place for Gal. Miguel. svn path=/trunk/; revision=6883 --- widgets/menus/gal-view-factory.c | 1 + widgets/misc/e-unicode.c | 8 ++++---- widgets/table/e-cell.c | 12 ++++++++++- widgets/table/e-cell.h | 18 +++++++---------- widgets/table/e-table-col.c | 1 - widgets/table/e-table-col.h | 16 ++++++--------- widgets/table/e-table-header.c | 2 +- widgets/table/e-table-model.c | 6 +++--- widgets/text/e-text-event-processor-types.h | 31 +++++++++++------------------ 9 files changed, 45 insertions(+), 50 deletions(-) (limited to 'widgets') diff --git a/widgets/menus/gal-view-factory.c b/widgets/menus/gal-view-factory.c index e9f36d806f..b1ea86cb0e 100644 --- a/widgets/menus/gal-view-factory.c +++ b/widgets/menus/gal-view-factory.c @@ -41,6 +41,7 @@ gal_view_factory_get_title (GalViewFactory *factory) /** * gal_view_factory_new_view * @factory: The factory to use + * @name: the name for the view. * * Returns: The new view */ diff --git a/widgets/misc/e-unicode.c b/widgets/misc/e-unicode.c index 487bff5e9d..d40cc7d88d 100644 --- a/widgets/misc/e-unicode.c +++ b/widgets/misc/e-unicode.c @@ -417,10 +417,10 @@ e_utf8_gtk_clist_append (GtkCList *clist, gchar *text[]) /** * g_unichar_to_utf8: - * @ch: a ISO10646 character code - * @out: output buffer, must have at least 6 bytes of space. - * If %NULL, the length will be computed and returned - * and nothing will be written to @out. + * @c: a ISO10646 character code + * @outbuf: output buffer, must have at least 6 bytes of space. + * If %NULL, the length will be computed and returned + * and nothing will be written to @out. * * Convert a single character to utf8 * diff --git a/widgets/table/e-cell.c b/widgets/table/e-cell.c index b4f01d6dde..ab22adb53e 100644 --- a/widgets/table/e-cell.c +++ b/widgets/table/e-cell.c @@ -131,6 +131,7 @@ E_MAKE_TYPE(e_cell, "ECell", ECell, e_cell_class_init, e_cell_init, PARENT_TYPE) * @model_col: the column in the model * @view_col: the column in the view * @row: the row + * @flags: the flags passed to the ECellView. * * Dispatches the event @event to the @ecell_view for. * @@ -226,7 +227,8 @@ e_cell_unrealize (ECellView *ecell_view) */ void e_cell_draw (ECellView *ecell_view, GdkDrawable *drawable, - int model_col, int view_col, int row, ECellFlags flags, int x1, int y1, int x2, int y2) + int model_col, int view_col, int row, ECellFlags flags, + int x1, int y1, int x2, int y2) { E_CELL_CLASS (GTK_OBJECT (ecell_view->ecell)->klass)->draw ( ecell_view, drawable, model_col, view_col, row, flags, x1, y1, x2, y2); @@ -234,6 +236,13 @@ e_cell_draw (ECellView *ecell_view, GdkDrawable *drawable, /** * e_cell_print: + * @ecell_view: the ECellView to redraw + * @context: The GnomePrintContext where we output our printed data. + * @model_col: the column in the model being drawn. + * @view_col: the column in the view being drawn (what the model maps to). + * @row: the row being drawn + * @width: width + * @height: height * * FIXME: */ @@ -303,6 +312,7 @@ e_cell_enter_edit (ECellView *ecell_view, int model_col, int view_col, int row) * @model_col: the column in the model * @view_col: the column in the view * @row: the row + * @edit_context: the editing context * * Notifies the ECellView that editing is finished at @model_col, @row * rendered at @view_col, @row. diff --git a/widgets/table/e-cell.h b/widgets/table/e-cell.h index faaf23b916..a76f7e37f4 100644 --- a/widgets/table/e-cell.h +++ b/widgets/table/e-cell.h @@ -13,11 +13,7 @@ #define E_IS_CELL(o) (GTK_CHECK_TYPE ((o), E_CELL_TYPE)) #define E_IS_CELL_CLASS(k) (GTK_CHECK_CLASS_TYPE ((k), E_CELL_TYPE)) -typedef struct _ECell ECell; -typedef struct _ECellView ECellView; -typedef enum _ECellFlags ECellFlags; - -enum _ECellFlags { +typedef enum { E_CELL_SELECTED = 1 << 0, E_CELL_JUSTIFICATION = 3 << 1, @@ -32,20 +28,20 @@ enum _ECellFlags { E_CELL_FOCUSED = 1 << 3, E_CELL_EDITING = 1 << 4, -}; +} ECellFlags; -struct _ECell { +typedef struct { GtkObject object; -}; +} ECell; -struct _ECellView { +typedef struct { ECell *ecell; ETableModel *e_table_model; void *e_table_item_view; gint focus_x1, focus_y1, focus_x2, focus_y2; gint focus_col, focus_row; -}; +} ECellView; #define E_CELL_IS_FOCUSED(ecell_view) (ecell_view->focus_x1 != -1) @@ -87,7 +83,7 @@ gint e_cell_event (ECellView *ecell_view, GdkEvent *event, int model_c void e_cell_realize (ECellView *ecell_view); void e_cell_unrealize (ECellView *ecell_view); -void e_cell_draw (ECellView *ecell_view, GdkDrawable *dr, +void e_cell_draw (ECellView *ecell_view, GdkDrawable *drawable, int model_col, int view_col, int row, ECellFlags flags, int x1, int y1, int x2, int y2); void e_cell_print (ECellView *ecell_view, GnomePrintContext *context, diff --git a/widgets/table/e-table-col.c b/widgets/table/e-table-col.c index 9b295a8a49..f1f2fb452d 100644 --- a/widgets/table/e-table-col.c +++ b/widgets/table/e-table-col.c @@ -151,7 +151,6 @@ e_table_col_new (int col_idx, const char *text, double expansion, int min_width, * e_table_col_new_with_pixbuf: * @col_idx: the column we represent in the model * @pixbuf: the image to be used for the header - * @text: a title for this column * @expansion: FIXME * @min_width: minimum width in pixels for this column * @ecell: the renderer to be used for this column diff --git a/widgets/table/e-table-col.h b/widgets/table/e-table-col.h index 3c8b883550..012fa10267 100644 --- a/widgets/table/e-table-col.h +++ b/widgets/table/e-table-col.h @@ -11,20 +11,16 @@ #define E_IS_TABLE_COL(o) (GTK_CHECK_TYPE ((o), E_TABLE_COL_TYPE)) #define E_IS_TABLE_COL_CLASS(k) (GTK_CHECK_CLASS_TYPE ((k), E_TABLE_COL_TYPE)) -typedef struct _ETableCol ETableCol; -typedef struct _ETableColClass ETableColClass; -typedef enum _ETableColArrow ETableColArrow; - -enum _ETableColArrow { +typedef enum { E_TABLE_COL_ARROW_NONE = 0, E_TABLE_COL_ARROW_UP, E_TABLE_COL_ARROW_DOWN -}; +} ETableColArrow; /* * Information about a single column */ -struct _ETableCol { +typedef struct { GtkObject base; char *text; GdkPixbuf *pixbuf; @@ -43,11 +39,11 @@ struct _ETableCol { GtkJustification justification; ECell *ecell; -}; +} ETableCol; -struct _ETableColClass { +typedef struct { GtkObjectClass parent_class; -}; +} ETableColClass; GtkType e_table_col_get_type (void); ETableCol *e_table_col_new (int col_idx, const char *text, diff --git a/widgets/table/e-table-header.c b/widgets/table/e-table-header.c index 20fe518122..9771a0d70d 100644 --- a/widgets/table/e-table-header.c +++ b/widgets/table/e-table-header.c @@ -302,7 +302,7 @@ eth_do_insert (ETableHeader *eth, int pos, ETableCol *val) /** * e_table_header_add_column: - * eth: the table header to add the column to. + * @eth: the table header to add the column to. * @tc: the ETableCol definition * @pos: position where the ETableCol will go. * diff --git a/widgets/table/e-table-model.c b/widgets/table/e-table-model.c index 566d28d084..09f6cbf215 100644 --- a/widgets/table/e-table-model.c +++ b/widgets/table/e-table-model.c @@ -94,7 +94,7 @@ e_table_model_value_at (ETableModel *e_table_model, int col, int row) * @e_table_model: the table model to operate on. * @col: the column where the data will be stored in the model. * @row: the row where the data will be stored in the model. - * @data: the data to be stored. + * @value: the data to be stored. * * This function instructs the model to store the value in @data in the * the @e_table_model at column @col and row @row. The @data typically @@ -105,12 +105,12 @@ e_table_model_value_at (ETableModel *e_table_model, int col, int row) * be a pointer to a set of data, or a datum that fits inside a void *. */ void -e_table_model_set_value_at (ETableModel *e_table_model, int col, int row, const void *data) +e_table_model_set_value_at (ETableModel *e_table_model, int col, int row, const void *value) { g_return_if_fail (e_table_model != NULL); g_return_if_fail (E_IS_TABLE_MODEL (e_table_model)); - ETM_CLASS (e_table_model)->set_value_at (e_table_model, col, row, data); + ETM_CLASS (e_table_model)->set_value_at (e_table_model, col, row, value); } /** diff --git a/widgets/text/e-text-event-processor-types.h b/widgets/text/e-text-event-processor-types.h index 8f2ffbaf39..1e012cdf1a 100644 --- a/widgets/text/e-text-event-processor-types.h +++ b/widgets/text/e-text-event-processor-types.h @@ -36,16 +36,9 @@ extern "C" { #include -typedef enum _ETextEventProcessorCommandPosition ETextEventProcessorCommandPosition; -typedef enum _ETextEventProcessorCommandAction ETextEventProcessorCommandAction; -typedef struct _ETextEventProcessorCommand ETextEventProcessorCommand; - typedef union _ETextEventProcessorEvent ETextEventProcessorEvent; -typedef struct _ETextEventProcessorEventButton ETextEventProcessorEventButton; -typedef struct _ETextEventProcessorEventKey ETextEventProcessorEventKey; -typedef struct _ETextEventProcessorEventMotion ETextEventProcessorEventMotion; -enum _ETextEventProcessorCommandPosition { +typedef enum { E_TEP_VALUE, E_TEP_SELECTION, @@ -73,9 +66,9 @@ enum _ETextEventProcessorCommandPosition { E_TEP_SELECT_WORD, E_TEP_SELECT_ALL -}; +} ETextEventProcessorCommandPosition; -enum _ETextEventProcessorCommandAction { +typedef enum { E_TEP_MOVE, E_TEP_SELECT, E_TEP_DELETE, @@ -91,39 +84,39 @@ enum _ETextEventProcessorCommandAction { E_TEP_UNGRAB, E_TEP_NOP -}; +} ETextEventProcessorCommandAction; -struct _ETextEventProcessorCommand { +typedef struct { ETextEventProcessorCommandPosition position; ETextEventProcessorCommandAction action; int value; char *string; guint32 time; -}; +} ETextEventProcessorCommand; -struct _ETextEventProcessorEventButton { +typedef struct { GdkEventType type; guint32 time; guint state; guint button; gint position; -}; +} ETextEventProcessorEventButton; -struct _ETextEventProcessorEventKey { +typedef struct { GdkEventType type; guint32 time; guint state; guint keyval; gint length; gchar *string; -}; +} ETextEventProcessorEventKey; -struct _ETextEventProcessorEventMotion { +typedef struct { GdkEventType type; guint32 time; guint state; gint position; -}; +} ETextEventProcessorEventMotion; union _ETextEventProcessorEvent { GdkEventType type; -- cgit v1.2.3