GNOME.org
 

[goffice] Doc fixes.

commit 23dc9ab6a6dfdc0467bc5cbb85329e3839d2a501
Author: Morten Welinder <terra gnome org>
Date:   Wed Mar 20 10:38:41 2013 -0400

    Doc fixes.

 docs/reference/goffice-0.10-sections.txt |   30 +++++++++++++++++++++-
 goffice/app/file-priv.h                  |    9 ++++++
 goffice/app/file.c                       |   36 ---------------------------
 goffice/app/file.h                       |   19 ++++++++++++-
 goffice/app/goffice-app.h                |   11 +++++---
 goffice/utils/datetime.h                 |    4 +++
 goffice/utils/go-geometry.c              |   40 +-----------------------------
 goffice/utils/go-geometry.h              |   40 +++++++++++++++++++++++++++--
 8 files changed, 104 insertions(+), 85 deletions(-)
---
diff --git a/docs/reference/goffice-0.10-sections.txt b/docs/reference/goffice-0.10-sections.txt
index dc3c6cd..f5bbbfd 100644
--- a/docs/reference/goffice-0.10-sections.txt
+++ b/docs/reference/goffice-0.10-sections.txt
@@ -1014,6 +1014,26 @@ go_font_sel_get_type
 </SECTION>
 
 <SECTION>
+<FILE>go-font-sel-dialog</FILE>
+<TITLE>GOFontSelDialog</TITLE>
+GOFontSelDialog
+go_font_sel_dialog_new
+go_font_sel_get_font_desc
+go_font_sel_get_sample_attributes
+go_font_sel_set_family
+go_font_sel_set_font_desc
+go_font_sel_set_sample_attributes
+go_font_sel_set_size
+go_font_sel_set_strikethrough
+go_font_sel_set_style
+<SUBSECTION Standard>
+GO_FONT_SEL_DIALOG
+GO_IS_FONT_SEL_DIALOG
+GO_TYPE_FONT_SEL_DIALOG
+go_font_sel_dialog_get_type
+</SECTION>
+
+<SECTION>
 <FILE>go-format</FILE>
 <TITLE>GOFormat</TITLE>
 GO_SUBSCRIPT_RISE
@@ -1118,12 +1138,13 @@ go_format_sel_get_type
 <SECTION>
 <FILE>go-geometry</FILE>
 <TITLE>Geometry helpers</TITLE>
-GODirection
 GOGeometryAABR
 GOGeometryOBR
 GOGeometryRotationType
 GOGeometrySide
 GO_GEOMETRY_ANGLE_TOLERANCE
+GODirection
+GO_TYPE_DIRECTION
 go_direction_get_name
 go_direction_is_forward
 go_direction_is_horizontal
@@ -1515,6 +1536,7 @@ GOMatrix3x3
 GOOptionMenu
 go_option_menu_get_history
 go_option_menu_new
+go_option_menu_select_item
 go_option_menu_set_history
 go_option_menu_set_menu
 <SUBSECTION Standard>
@@ -1937,6 +1959,10 @@ go_exponential_regression_as_logl
 go_exponential_regressionl
 go_linear_regression
 go_linear_regressionl
+go_linear_regression_leverage
+go_linear_regression_leveragel
+go_linear_solve_multiple
+go_linear_solve_multiplel
 go_linear_solve
 go_linear_solvel
 go_logarithmic_fit
@@ -2606,6 +2632,7 @@ go_gtk_dialog_add_button
 go_gtk_dialog_run
 go_gtk_editable_enters
 go_gtk_file_sel_dialog
+go_gtk_grid_remove_row
 go_gtk_help_button_init
 go_gtk_nonmodal_dialog
 go_gtk_notice_dialog
@@ -2616,6 +2643,7 @@ go_gtk_select_image_with_extra_widget
 go_gtk_url_is_writeable
 go_gtk_url_show
 go_gtk_widget_disable_focus
+go_gtk_widget_replace
 go_gtk_window_set_transient
 go_gui_get_image_save_info
 go_menu_position_below
diff --git a/goffice/app/file-priv.h b/goffice/app/file-priv.h
index 896b38b..3a8c5c9 100644
--- a/goffice/app/file-priv.h
+++ b/goffice/app/file-priv.h
@@ -13,6 +13,15 @@ G_BEGIN_DECLS
 #define GO_FILE_OPENER_METHOD(obj,name) \
         ((GO_FILE_OPENER_CLASS (G_OBJECT_GET_CLASS (obj)))->name)
 
+/**
+ * GOFileOpenerClass:
+ * @parent_class: parent class.
+ * @can_probe: returns %TRUE if the files can be probed.
+ * @probe: probes the file.
+ * @open: opens and reads the file.
+ *
+ * File opener base class.
+ **/
 struct _GOFileOpenerClass {
        GObjectClass parent_class;
 
diff --git a/goffice/app/file.c b/goffice/app/file.c
index 83db773..f1c6178 100644
--- a/goffice/app/file.c
+++ b/goffice/app/file.c
@@ -40,42 +40,6 @@
 #include <string.h>
 #include <glib/gi18n-lib.h>
 
-/**
- * GOFileFormatLevel:
- * @GO_FILE_FL_NONE: no name assigned, won't happen.
- * @GO_FILE_FL_WRITE_ONLY: PostScript etc, won't be remembered.
- * @GO_FILE_FL_NEW: Wb just created.
- * @GO_FILE_FL_MANUAL: Save gets punted to save as.
- * @GO_FILE_FL_MANUAL_REMEMBER: Ditto, but remember in history.
- * @GO_FILE_FL_AUTO: Save will save to this filename.
- * @GO_FILE_FL_LAST: last value, won't happen.
- **/
-
-/**
- * GOFileSaveScope:
- * @GO_FILE_SAVE_WORKBOOK: save the whole file.
- * @GO_FILE_SAVE_SHEET: save only current page.
- * @GO_FILE_SAVE_RANGE: save only a selected range.
- * @GO_FILE_SAVE_LAST: last value, won't happen.
- **/
-
-/**
- * GOFileProbeLevel:
- * @GO_FILE_PROBE_FILE_NAME: test only file name, don't read file contents.
- * @GO_FILE_PROBE_CONTENT: read the whole file if it's necessary.
- * @GO_FILE_PROBE_LAST: last value, won't happen.
- **/
-
-/**
- * GOFileOpenerClass:
- * @parent_class: parent class.
- * @can_probe: returns %TRUE if the files can be probed.
- * @probe: probes the file.
- * @open: opens and reads the file.
- *
- * File opener base class.
- **/
-
 enum {
        FO_PROP_0,
        FO_PROP_ID,
diff --git a/goffice/app/file.h b/goffice/app/file.h
index bc26977..576f501 100644
--- a/goffice/app/file.h
+++ b/goffice/app/file.h
@@ -6,7 +6,16 @@
 
 G_BEGIN_DECLS
 
-/*
+/**
+ * GOFileFormatLevel:
+ * @GO_FILE_FL_NONE: no name assigned, won't happen.
+ * @GO_FILE_FL_WRITE_ONLY: PostScript etc, won't be remembered.
+ * @GO_FILE_FL_NEW: Wb just created.
+ * @GO_FILE_FL_MANUAL: Save gets punted to save as.
+ * @GO_FILE_FL_MANUAL_REMEMBER: Ditto, but remember in history.
+ * @GO_FILE_FL_AUTO: Save will save to this filename.
+ * @GO_FILE_FL_LAST: last value, won't happen.
+ *
  * File format levels. They are ordered. When we save a file, we
  * remember the name, but not if we already have a name at a higher level.
  * When created, workbooks are assigned a name at level GO_FILE_FL_NEW.
@@ -23,7 +32,13 @@ typedef enum {
 GType go_file_format_level_get_type (void);
 #define GO_TYPE_FILE_FORMAT_LEVEL (go_file_format_level_get_type ())
 
-/*
+/**
+ * GOFileSaveScope:
+ * @GO_FILE_SAVE_WORKBOOK: save the whole file.
+ * @GO_FILE_SAVE_SHEET: save only current page.
+ * @GO_FILE_SAVE_RANGE: save only a selected range.
+ * @GO_FILE_SAVE_LAST: last value, won't happen.
+ *
  * GOFileSaveScope specifies what information file saver can save in a file.
  * Many savers can save the whole workbook (with all sheets), but others
  * save only current sheet, usually because of file format limitations.
diff --git a/goffice/app/goffice-app.h b/goffice/app/goffice-app.h
index 5edf2d8..2460fae 100644
--- a/goffice/app/goffice-app.h
+++ b/goffice/app/goffice-app.h
@@ -41,7 +41,11 @@ typedef struct _GOFileSaver          GOFileSaver;
 typedef struct _GOFileOpener           GOFileOpener;
 typedef struct _GOIOContext            GOIOContext;
 
-/*
+/**
+ * GOFileProbeLevel:
+ * @GO_FILE_PROBE_FILE_NAME: Test only file name, don't read file contents
+ * @GO_FILE_PROBE_CONTENT: Read the whole file if it's necessary
+ *
  * File probe level tells file opener (its probe method to be exact), how
  * hard it should try to recognize the type of the file. File openers may
  * ignore this or support only some probe levels, but if specifies
@@ -52,9 +56,8 @@ typedef struct _GOIOContext           GOIOContext;
  * we increase probe level and try again...
  */
 typedef enum {
-       GO_FILE_PROBE_FILE_NAME,        /* Test only file name, don't read file contents */
-       GO_FILE_PROBE_CONTENT,  /* Read the whole file if it's necessary */
-       GO_FILE_PROBE_LAST
+       GO_FILE_PROBE_FILE_NAME,
+       GO_FILE_PROBE_CONTENT
 } GOFileProbeLevel;
 
 G_END_DECLS
diff --git a/goffice/utils/datetime.h b/goffice/utils/datetime.h
index d7ae4ce..f3b8797 100644
--- a/goffice/utils/datetime.h
+++ b/goffice/utils/datetime.h
@@ -6,6 +6,10 @@
 
 G_BEGIN_DECLS
 
+/**
+ * GODateConventions:
+ * @use_1904: Base on 1904 as opposed to 1900.
+ */
 struct _GODateConventions {
        gboolean use_1904;      /* Use MacOffice 1904 based date convention,
                                 * Rather than the Win32 style 1900 */
diff --git a/goffice/utils/go-geometry.c b/goffice/utils/go-geometry.c
index 5516cb7..065739b 100644
--- a/goffice/utils/go-geometry.c
+++ b/goffice/utils/go-geometry.c
@@ -26,45 +26,7 @@
 
 #include <glib/gi18n-lib.h>
 
-/**
- * GOGeometrySide:
- * @GO_SIDE_LEFT: left.
- * @GO_SIDE_RIGHT: right.
- * @GO_SIDE_LEFT_RIGHT: left or right.
- * @GO_SIDE_TOP: top.
- * @GO_SIDE_BOTTOM: bottom.
- * @GO_SIDE_TOP_BOTTOM: top or bottom.
- * @GO_SIDE_AUTO: auto.
- **/
-
-/**
- * GODirection:
- * @GO_DIRECTION_UP: up.
- * @GO_DIRECTION_DOWN: down.
- * @GO_DIRECTION_LEFT: left.
- * @GO_DIRECTION_RIGHT: right.
- * @GO_DIRECTION_NONE: no direction.
- **/
-
-/**
- * GOGeometryRotationType:
- * @GO_ROTATE_NONE: no rotation.
- * @GO_ROTATE_COUNTERCLOCKWISE: counter clockwise.
- * @GO_ROTATE_UPSIDEDOWN: upside down.
- * @GO_ROTATE_CLOCKWISE: clockwise.
- * @GO_ROTATE_FREE: free rotation.
- **/
-
-/**
- * GOGeometryOBR:
- * @x: vertical position of the center.
- * @y: vertical position of the center.
- * @w: width.
- * @h: height.
- * @alpha: Aangle from x axis to w edge, in radians.
- **/
-
-#define dist(x0, y0, x1, y1) hypot((x0) - (x1),(y0) - (y1))
+#define dist(x0,y0,x1,y1) hypot((x0) - (x1),(y0) - (y1))
 
 /**
  * go_geometry_cartesian_to_polar:
diff --git a/goffice/utils/go-geometry.h b/goffice/utils/go-geometry.h
index bae6883..db1e95a 100644
--- a/goffice/utils/go-geometry.h
+++ b/goffice/utils/go-geometry.h
@@ -28,6 +28,16 @@ G_BEGIN_DECLS
 
 #define GO_GEOMETRY_ANGLE_TOLERANCE 1E-3
 
+/**
+ * GOGeometrySide:
+ * @GO_SIDE_LEFT: left.
+ * @GO_SIDE_RIGHT: right.
+ * @GO_SIDE_LEFT_RIGHT: left or right.
+ * @GO_SIDE_TOP: top.
+ * @GO_SIDE_BOTTOM: bottom.
+ * @GO_SIDE_TOP_BOTTOM: top or bottom.
+ * @GO_SIDE_AUTO: auto.
+ **/
 typedef enum {
        GO_SIDE_LEFT            = 1 << 0,
        GO_SIDE_RIGHT           = 1 << 1,
@@ -38,6 +48,14 @@ typedef enum {
        GO_SIDE_AUTO            = 15
 } GOGeometrySide;
 
+/**
+ * GODirection:
+ * @GO_DIRECTION_UP: up.
+ * @GO_DIRECTION_DOWN: down.
+ * @GO_DIRECTION_LEFT: left.
+ * @GO_DIRECTION_RIGHT: right.
+ * @GO_DIRECTION_NONE: no direction.
+ **/
 typedef enum {
        GO_DIRECTION_UP    = 0,
        GO_DIRECTION_DOWN  = 1,
@@ -46,6 +64,14 @@ typedef enum {
        GO_DIRECTION_NONE  = 4
 } GODirection;
 
+/**
+ * GOGeometryRotationType:
+ * @GO_ROTATE_NONE: no rotation.
+ * @GO_ROTATE_COUNTERCLOCKWISE: counter clockwise.
+ * @GO_ROTATE_UPSIDEDOWN: upside down.
+ * @GO_ROTATE_CLOCKWISE: clockwise.
+ * @GO_ROTATE_FREE: free rotation.
+ **/
 typedef enum {
        GO_ROTATE_NONE = 0,
        GO_ROTATE_COUNTERCLOCKWISE = 1,
@@ -54,10 +80,18 @@ typedef enum {
        GO_ROTATE_FREE = 4
 } GOGeometryRotationType;
 
+/**
+ * GOGeometryOBR:
+ * @x: horizontal position of the center.
+ * @y: vertical position of the center.
+ * @w: width of edge.
+ * @h: height of edge.
+ * @alpha: Aangle from x axis to w edge, in radians.
+ **/
 typedef struct {
-        double x,y;     /* Center */
-        double w,h;     /* Edges */
-        double alpha;   /* Angle from x axis to w edge, in radians */
+        double x, y;
+        double w, h;
+        double alpha;
 } GOGeometryOBR;
 
 typedef struct _GogViewAllocation GOGeometryAABR;
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]