[Author Prev][Author Next][Thread Prev][Thread Next][Author Index][Thread Index]
gEDA-cvs: gaf.git: branch: master updated (1.6.0-20091004-24-gf30b66a)
The branch, master has been updated
via f30b66a2d02592c907b1ac15270f34d8f62f1327 (commit)
via f1e5729f9638731595c2af4ecf5c492d8de4076d (commit)
from 93dd5a941f34d1dd58cf9a57a07dec1e01ce3afe (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
=========
Summary
=========
gschem/docs/what-is-gschem.html | 4 +-
gschem/src/g_hook.c | 12 ++++++----
gschem/src/gschem_accel_label.c | 4 +-
gschem/src/gschem_action.c | 2 +-
gschem/src/gschem_dialog.c | 2 +-
gschem/src/gschem_pango.c | 14 +++++-------
gschem/src/i_basic.c | 1 -
gschem/src/o_basic.c | 1 -
gschem/src/o_box.c | 26 +++++++--------------
gschem/src/o_bus.c | 4 +-
gschem/src/o_circle.c | 28 ++++++++++-------------
gschem/src/o_find.c | 1 -
gschem/src/o_grips.c | 6 ++--
gschem/src/o_line.c | 2 +-
gschem/src/o_misc.c | 2 +-
gschem/src/o_path.c | 4 +++
gschem/src/o_select.c | 2 +-
gschem/src/x_compselect.c | 2 +-
gschem/src/x_dialog.c | 45 +++++++++++++++++++++-----------------
gschem/src/x_fileselect.c | 2 +-
gschem/src/x_multiattrib.c | 2 +-
gschem/src/x_pagesel.c | 2 +-
gschem/src/x_window.c | 19 ++++++++-------
libgeda/src/m_circle.c | 2 +-
libgeda/src/m_line.c | 2 +-
libgeda/src/o_attrib.c | 4 +-
libgeda/src/o_bus_basic.c | 1 -
libgeda/src/o_complex_basic.c | 1 -
libgeda/src/o_list.c | 1 -
libgeda/src/o_net_basic.c | 1 -
libgeda/src/o_pin_basic.c | 3 +-
libgeda/src/o_text_basic.c | 4 +-
libgeda/src/s_log.c | 2 +-
33 files changed, 99 insertions(+), 109 deletions(-)
=================
Commit Messages
=================
commit f30b66a2d02592c907b1ac15270f34d8f62f1327
Author: Gareth Edwards <gareth@xxxxxxxxxxxxxxxxxxxx>
Commit: Peter TB Brett <peter@xxxxxxxxxxxxx>
libgeda: clean up doxygen warnings [2899355]
Some of the doxygen comments for libgeda have
fallen into bitrot, particularly around parameter names and lists.
This patch updates doxygen comments to fix almost all warnings generated
in the libgeda doxygen run.
:100644 100644 815d54e... 2861049... M libgeda/src/m_circle.c
:100644 100644 7c1b0e2... 8fedce8... M libgeda/src/m_line.c
:100644 100644 f7edafb... 1e7ac0c... M libgeda/src/o_attrib.c
:100644 100644 da5ac22... cdedb3d... M libgeda/src/o_bus_basic.c
:100644 100644 3e2df60... f3144df... M libgeda/src/o_complex_basic.c
:100644 100644 1bc8939... 8b70b39... M libgeda/src/o_list.c
:100644 100644 032fce1... e8074c1... M libgeda/src/o_net_basic.c
:100644 100644 0de72e4... 3cbf123... M libgeda/src/o_pin_basic.c
:100644 100644 2f8b7a7... 2260573... M libgeda/src/o_text_basic.c
:100644 100644 372a6f6... 9bd4419... M libgeda/src/s_log.c
commit f1e5729f9638731595c2af4ecf5c492d8de4076d
Author: Gareth Edwards <gareth@xxxxxxxxxxxxxxxxxxxx>
Commit: Peter TB Brett <peter@xxxxxxxxxxxxx>
gschem: Clean up doxygen warnings [2899355]
Quite a few of the doxygen comments for gschem have
fallen into bitrot, particularly around parameter names and lists.
This patch updates doxygen comments to fix almost all warnings generated
in the gschem doxygen run. Also corrected apostrophe error on main page.
:100644 100644 38adf5e... a24bfe6... M gschem/docs/what-is-gschem.html
:100644 100644 863057d... e666956... M gschem/src/g_hook.c
:100644 100644 8dc75a5... f349ded... M gschem/src/gschem_accel_label.c
:100644 100644 428a831... bdadebc... M gschem/src/gschem_action.c
:100644 100644 4a4f788... 53093eb... M gschem/src/gschem_dialog.c
:100644 100644 2a2821e... ca4199d... M gschem/src/gschem_pango.c
:100644 100644 6f3a76e... 0ae00b9... M gschem/src/i_basic.c
:100644 100644 ff6a537... df8858d... M gschem/src/o_basic.c
:100644 100644 36f2080... e967fc6... M gschem/src/o_box.c
:100644 100644 d9a92bf... 7a5f295... M gschem/src/o_bus.c
:100644 100644 67c5505... a7e1420... M gschem/src/o_circle.c
:100644 100644 65b55d7... db2ae72... M gschem/src/o_find.c
:100644 100644 36b421f... 1b7f78a... M gschem/src/o_grips.c
:100644 100644 f41d4e2... 2d9ac27... M gschem/src/o_line.c
:100644 100644 93275ff... a0f652a... M gschem/src/o_misc.c
:100644 100644 fc0140e... 496a13c... M gschem/src/o_path.c
:100644 100644 d9153f0... 6778a2a... M gschem/src/o_select.c
:100644 100644 7e39e1c... ab6be05... M gschem/src/x_compselect.c
:100644 100644 54992e5... ff14ec2... M gschem/src/x_dialog.c
:100644 100644 46c3ea6... c63f5d7... M gschem/src/x_fileselect.c
:100644 100644 5e764eb... 201b11f... M gschem/src/x_multiattrib.c
:100644 100644 1de297f... 15385c9... M gschem/src/x_pagesel.c
:100644 100644 283fae1... 714183e... M gschem/src/x_window.c
=========
Changes
=========
commit f30b66a2d02592c907b1ac15270f34d8f62f1327
Author: Gareth Edwards <gareth@xxxxxxxxxxxxxxxxxxxx>
Commit: Peter TB Brett <peter@xxxxxxxxxxxxx>
libgeda: clean up doxygen warnings [2899355]
Some of the doxygen comments for libgeda have
fallen into bitrot, particularly around parameter names and lists.
This patch updates doxygen comments to fix almost all warnings generated
in the libgeda doxygen run.
diff --git a/libgeda/src/m_circle.c b/libgeda/src/m_circle.c
index 815d54e..2861049 100644
--- a/libgeda/src/m_circle.c
+++ b/libgeda/src/m_circle.c
@@ -18,7 +18,7 @@
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111 USA
*/
-/*! \file m_geometry.c
+/*! \file m_circle.c
*
* \brief Low-level mathmatical functions for circles
*/
diff --git a/libgeda/src/m_line.c b/libgeda/src/m_line.c
index 7c1b0e2..8fedce8 100644
--- a/libgeda/src/m_line.c
+++ b/libgeda/src/m_line.c
@@ -18,7 +18,7 @@
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111 USA
*/
-/*! \file m_geometry.c
+/*! \file m_line.c
*
* \brief Low-level mathmatical functions for lines
*/
diff --git a/libgeda/src/o_attrib.c b/libgeda/src/o_attrib.c
index f7edafb..1e7ac0c 100644
--- a/libgeda/src/o_attrib.c
+++ b/libgeda/src/o_attrib.c
@@ -455,7 +455,7 @@ GList *o_attrib_find_floating_attribs (const GList *list)
*
* \param [in] list GList of attributes to search.
* \param [in] name Character string with attribute name to search for.
- * \param [in] counter Which occurance to return.
+ * \param [in] count Which occurance to return.
* \return The n'th attribute object in the given list with the given name.
*/
OBJECT *o_attrib_find_attrib_by_name (const GList *list, char *name, int count)
@@ -674,7 +674,7 @@ GList * o_attrib_return_attribs (OBJECT *object)
* This function returns TRUE if the given attribute OBJECT is a
* toplevel un-attached attribute inside a complex's prim_objs.
*
- * \param [in] object OBJECT who's status to query.
+ * \param [in] attrib OBJECT who's status to query.
* \return TRUE if the given attribute is inside a symbol
*/
int o_attrib_is_inherited (OBJECT *attrib)
diff --git a/libgeda/src/o_bus_basic.c b/libgeda/src/o_bus_basic.c
index da5ac22..cdedb3d 100644
--- a/libgeda/src/o_bus_basic.c
+++ b/libgeda/src/o_bus_basic.c
@@ -151,7 +151,6 @@ void o_bus_recalc(TOPLEVEL *toplevel, OBJECT *o_current)
* allocated and appended to the \a object_list.
*
* \param [in] toplevel The TOPLEVEL object
- * \param [in] object_list list of OBJECTS to append a new bus
* \param [in] buf a text buffer (usually a line of a schematic file)
* \param [in] release_ver The release number gEDA
* \param [in] fileformat_ver a integer value of the file format
diff --git a/libgeda/src/o_complex_basic.c b/libgeda/src/o_complex_basic.c
index 3e2df60..f3144df 100644
--- a/libgeda/src/o_complex_basic.c
+++ b/libgeda/src/o_complex_basic.c
@@ -658,7 +658,6 @@ void o_complex_recalc(TOPLEVEL *toplevel, OBJECT *o_current)
* allocated and appended to the \a object_list.
*
* \param [in] toplevel The TOPLEVEL object
- * \param [in] object_list list of OBJECTS to append a new net
* \param [in] buf a text buffer (usually a line of a schematic file)
* \param [in] release_ver The release number gEDA
* \param [in] fileformat_ver a integer value of the file format
diff --git a/libgeda/src/o_list.c b/libgeda/src/o_list.c
index 1bc8939..8b70b39 100644
--- a/libgeda/src/o_list.c
+++ b/libgeda/src/o_list.c
@@ -44,7 +44,6 @@ extern int global_sid;
* \param [in] toplevel The TOPLEVEL object.
* \param [in] selected
* \param [in] flag
- * \param [out] return_end
* \return OBJECT pointer.
*/
OBJECT *o_object_copy (TOPLEVEL *toplevel,
diff --git a/libgeda/src/o_net_basic.c b/libgeda/src/o_net_basic.c
index 032fce1..e8074c1 100644
--- a/libgeda/src/o_net_basic.c
+++ b/libgeda/src/o_net_basic.c
@@ -148,7 +148,6 @@ void o_net_recalc(TOPLEVEL *toplevel, OBJECT *o_current)
* allocated and appended to the \a object_list.
*
* \param [in] toplevel The TOPLEVEL object
- * \param [in] object_list list of OBJECTS to append a new net
* \param [in] buf a text buffer (usually a line of a schematic file)
* \param [in] release_ver The release number gEDA
* \param [in] fileformat_ver a integer value of the file format
diff --git a/libgeda/src/o_pin_basic.c b/libgeda/src/o_pin_basic.c
index 0de72e4..3cbf123 100644
--- a/libgeda/src/o_pin_basic.c
+++ b/libgeda/src/o_pin_basic.c
@@ -150,7 +150,6 @@ void o_pin_recalc(TOPLEVEL *toplevel, OBJECT *o_current)
* allocated and appended to the \a object_list.
*
* \param [in] toplevel The TOPLEVEL object
- * \param [in] object_list list of OBJECTS to append a new pin
* \param [in] buf a text buffer (usually a line of a schematic file)
* \param [in] release_ver The release number gEDA
* \param [in] fileformat_ver a integer value of the file format
@@ -567,7 +566,7 @@ void o_pin_update_whichend(TOPLEVEL *toplevel,
*
* \param [in] toplevel The TOPLEVEL object
* \param [in] o_current The pin OBJECT being modified
- * \param [in] type The new type of this pin
+ * \param [in] pin_type The new type of this pin
*/
void o_pin_set_type (TOPLEVEL *toplevel, OBJECT *o_current, int pin_type)
{
diff --git a/libgeda/src/o_text_basic.c b/libgeda/src/o_text_basic.c
index 2f8b7a7..2260573 100644
--- a/libgeda/src/o_text_basic.c
+++ b/libgeda/src/o_text_basic.c
@@ -102,7 +102,7 @@ int tab_in_chars = 8;
* This functions updates the text->disp_string according
* to the object->show_name_value settings
*
- * \param [in] o The OBJECT to update
+ * \param [in] object The OBJECT to update
*/
static void update_disp_string (OBJECT *object)
{
@@ -321,7 +321,6 @@ void o_text_recalc(TOPLEVEL *toplevel, OBJECT *o_current)
* create and appended to the \a object_list.
*
* \param [in] toplevel The TOPLEVEL object
- * \param [in] object_list list of OBJECTS to append a new text
* \param [in] first_line the first line of the text
* \param [in] tb a text buffer (usually a line of a schematic file)
* \param [in] release_ver The release number gEDA
@@ -1015,6 +1014,7 @@ const gchar *o_text_get_string (TOPLEVEL *toplevel, OBJECT *obj)
* Set the function to be used to calculate text bounds for a given
* #TOPLEVEL.
*
+ * \param [in] toplevel The TOPLEVEL object
* \param [in] func Function to use.
* \param [in] user_data User data to be passed to the function.
*/
diff --git a/libgeda/src/s_log.c b/libgeda/src/s_log.c
index 372a6f6..9bd4419 100644
--- a/libgeda/src/s_log.c
+++ b/libgeda/src/s_log.c
@@ -72,7 +72,7 @@ static guint log_handler_id;
* This function opens the file <B>filename</B> to log to and registers the
* handler to redirect log message to this file.
*
- * \param [in] filename Character string with file name to log to.
+ * \param [in] prefix Character string with file name prefix to log to.
*/
void s_log_init (const gchar *prefix)
{
commit f1e5729f9638731595c2af4ecf5c492d8de4076d
Author: Gareth Edwards <gareth@xxxxxxxxxxxxxxxxxxxx>
Commit: Peter TB Brett <peter@xxxxxxxxxxxxx>
gschem: Clean up doxygen warnings [2899355]
Quite a few of the doxygen comments for gschem have
fallen into bitrot, particularly around parameter names and lists.
This patch updates doxygen comments to fix almost all warnings generated
in the gschem doxygen run. Also corrected apostrophe error on main page.
diff --git a/gschem/docs/what-is-gschem.html b/gschem/docs/what-is-gschem.html
index 38adf5e..a24bfe6 100644
--- a/gschem/docs/what-is-gschem.html
+++ b/gschem/docs/what-is-gschem.html
@@ -1,5 +1,5 @@
<body>
What is gSchem?
<p/>
-gschem is the schematic capture program/tool which is part of gEDA. It's sole purpose is to facilitate the graphical input of components/circuits.
-</body>
\ No newline at end of file
+gschem is the schematic capture program/tool which is part of gEDA. Its sole purpose is to facilitate the graphical input of components/circuits.
+</body>
diff --git a/gschem/src/g_hook.c b/gschem/src/g_hook.c
index 863057d..e666956 100644
--- a/gschem/src/g_hook.c
+++ b/gschem/src/g_hook.c
@@ -520,9 +520,9 @@ static void custom_world_get_object_glist_bounds
* scm_exclude_attribs, neither the object types included in
* scm_exclude_object_type
* \param [in] object_smob The object we want to know the bounds of.
- * \param [in] exclude_attrib_list A list with the attribute names we don't
+ * \param [in] scm_exclude_attribs A list with the attribute names we don't
* want to include when calculing the bounds.
- * \param [in] exclude_obj_type_list A list with the object types we don't
+ * \param [in] scm_exclude_object_type A list with the object types we don't
* want to include when calculing the bounds.
* The object types are those used in (OBJECT *)->type converted into strings.
* \return a list of the bounds of the <B>object smob</B>.
@@ -639,11 +639,13 @@ SCM g_get_object_pins (SCM object_smob)
* Adds a component <B>scm_comp_name</B> to the schematic, at
* position (<B>scm_x</B>, <B>scm_y</B>), with some properties set by
* the parameters:
+ * \param [in,out] page_smob Schematic page
+ * \param [in] scm_comp_name Component to be added
* \param [in] scm_x Coordinate X of the symbol.
* \param [in] scm_y Coordinate Y of the symbol.
- * \param [in] angle Angle of rotation of the symbol.
- * \param [in] selectable True if the symbol is selectable, false otherwise.
- * \param [in] mirror True if the symbol is mirrored, false otherwise.
+ * \param [in] scm_angle Angle of rotation of the symbol.
+ * \param [in] scm_selectable True if the symbol is selectable, false otherwise.
+ * \param [in] scm_mirror True if the symbol is mirrored, false otherwise.
* If scm_comp_name is a scheme empty list, SCM_BOOL_F, or an empty
* string (""), then g_add_component returns SCM_BOOL_F without writing
* to the log.
diff --git a/gschem/src/gschem_accel_label.c b/gschem/src/gschem_accel_label.c
index 8dc75a5..f349ded 100644
--- a/gschem/src/gschem_accel_label.c
+++ b/gschem/src/gschem_accel_label.c
@@ -290,8 +290,8 @@ substitute_underscores (char *str)
/**
* gschem_accel_label_set_accel_string:
- * @accel_label: a #GschemAccelLabel
- * @accel_string: the accelerator string.
+ * \param accel_label a #GschemAccelLabel
+ * \param accel_string the accelerator string.
*
* Sets the accelerator string for this accelerator label.
**/
diff --git a/gschem/src/gschem_action.c b/gschem/src/gschem_action.c
index 428a831..bdadebc 100644
--- a/gschem/src/gschem_action.c
+++ b/gschem/src/gschem_action.c
@@ -37,7 +37,7 @@ static GObjectClass *gschem_action_parent_class = NULL;
* Just before the GschemAction GObject is finalized, free our
* allocated data, and then chain up to the parent's finalize handler.
*
- * \param [in] widget The GObject being finalized.
+ * \param [in] object The GObject being finalized.
*/
static void gschem_action_finalize (GObject *object)
{
diff --git a/gschem/src/gschem_dialog.c b/gschem/src/gschem_dialog.c
index 4a4f788..53093eb 100644
--- a/gschem/src/gschem_dialog.c
+++ b/gschem/src/gschem_dialog.c
@@ -259,7 +259,7 @@ static void unmap_handler (GtkWidget *widget)
* Just before the GschemDialog GObject is finalized, free our
* allocated data, and then chain up to the parent's finalize handler.
*
- * \param [in] widget The GObject being finalized.
+ * \param [in] object The GObject being finalized.
*/
static void gschem_dialog_finalize (GObject *object)
{
diff --git a/gschem/src/gschem_pango.c b/gschem/src/gschem_pango.c
index 2a2821e..ca4199d 100644
--- a/gschem/src/gschem_pango.c
+++ b/gschem/src/gschem_pango.c
@@ -296,13 +296,13 @@ gschem_pango_renderer_class_init (GschemPangoRendererClass *klass)
}
/*!
- * gschem_pango_renderer_new:
- * @cr: a #cairo renderer
+ * \brief Create a new PangoRenderer
*
- * Creates a new #PangoRenderer for @cr. Normally you can use the results
+ * Create a new #PangoRenderer. Normally you can use the results
* of gschem_pango_renderer_get_default() rather than creating a new renderer.
*
- * Return value: a newly created #PangoRenderer. Free with g_object_unref().
+ * \param [in] cr a cairo renderer
+ * \return a newly created #PangoRenderer. Free with g_object_unref().
*/
PangoRenderer *
gschem_pango_renderer_new (cairo_t *cr)
@@ -361,12 +361,10 @@ gschem_pango_attr_overbar_compare (const PangoAttribute *attr1,
}
/*!
- * gschem_pango_attr_overbar_new:
- * @overbar: if the region should be drawn with an overbar
- *
* Creates a new attribute flagging a region as being drawn with overbar or not
*
- * Return value: new #PangoAttribute
+ * \param [in] overbar if the region should be drawn with an overbar
+ * \return a new #PangoAttribute
*/
PangoAttribute *
gschem_pango_attr_overbar_new (gboolean overbar)
diff --git a/gschem/src/i_basic.c b/gschem/src/i_basic.c
index 6f3a76e..0ae00b9 100644
--- a/gschem/src/i_basic.c
+++ b/gschem/src/i_basic.c
@@ -532,7 +532,6 @@ void i_set_filename(GSCHEM_TOPLEVEL *w_current, const gchar *string)
* The format is "Grid([SnapGridSize],[CurrentGridSize])"
*
* \param [in] w_current GSCHEM_TOPLEVEL structure
- * \param [in] visible_grid Visible grid size
*/
void i_update_grid_info (GSCHEM_TOPLEVEL *w_current)
{
diff --git a/gschem/src/o_basic.c b/gschem/src/o_basic.c
index ff6a537..df8858d 100644
--- a/gschem/src/o_basic.c
+++ b/gschem/src/o_basic.c
@@ -522,7 +522,6 @@ void o_invalidate_rect (GSCHEM_TOPLEVEL *w_current,
* of NULL, causing the entire drawing area to be invalidated.
*
* \param [in] w_current The GSCHEM_TOPLEVEL object.
- * \param [in] object The OBJECT invalidated on screen.
*/
void o_invalidate_all (GSCHEM_TOPLEVEL *w_current)
{
diff --git a/gschem/src/o_box.c b/gschem/src/o_box.c
index 36f2080..e967fc6 100644
--- a/gschem/src/o_box.c
+++ b/gschem/src/o_box.c
@@ -191,10 +191,8 @@ void o_box_draw(GSCHEM_TOPLEVEL *w_current, OBJECT *o_current)
* \param [in] w GdkDrawable to draw in.
* \param [in] gc GdkGC graphics context to draw on.
* \param [in] color Box fill color.
- * \param [in] x Upper x coordinate of BOX.
- * \param [in] y Upper y coordinate of BOX.
- * \param [in] width Width of BOX.
- * \param [in] height Height of BOX.
+ * \param [in] w_current Schematic top level
+ * \param [in] box Box definition
* \param [in] fill_width BOX pattern fill width.
* \param [in] angle1 1st angle for pattern.
* \param [in] pitch1 1st pitch for pattern.
@@ -223,11 +221,9 @@ void o_box_fill_hollow (GdkDrawable *w, GdkGC *gc, COLOR *color,
*
* \param [in] w GdkDrawable to draw in.
* \param [in] gc GdkGC graphics context to draw on.
- * \param [in] color Box fill color.
- * \param [in] x Upper x coordinate of BOX.
- * \param [in] y Upper y coordinate of BOX.
- * \param [in] width Width of BOX.
- * \param [in] height Height of BOX.
+ * \param [in] color Box fill color.
+ * \param [in] w_current Schematic top level
+ * \param [in] box Box definition
* \param [in] fill_width BOX pattern fill width.
* \param [in] angle1 (unused)
* \param [in] pitch1 (unused)
@@ -263,10 +259,8 @@ void o_box_fill_fill (GdkDrawable *w, GdkGC *gc, COLOR *color,
* \param [in] w GdkDrawable to draw in.
* \param [in] gc GdkGC graphics context to draw on.
* \param [in] color Box fill color.
- * \param [in] x Upper x coordinate of BOX.
- * \param [in] y Upper y coordinate of BOX.
- * \param [in] width Width of BOX.
- * \param [in] height Height of BOX.
+ * \param [in] w_current Schematic top level
+ * \param [in] box Box definition
* \param [in] fill_width BOX pattern fill width.
* \param [in] angle1 1st angle for pattern.
* \param [in] pitch1 1st pitch for pattern.
@@ -315,10 +309,8 @@ void o_box_fill_hatch (GdkDrawable *w, GdkGC *gc, COLOR *color,
* \param [in] w GdkDrawable to draw in.
* \param [in] gc GdkGC graphics context to draw on.
* \param [in] color Box fill color.
- * \param [in] x Upper x coordinate of BOX.
- * \param [in] y Upper y coordinate of BOX.
- * \param [in] width Width of BOX.
- * \param [in] height Height of BOX.
+ * \param [in] w_current Schematic top level
+ * \param [in] box Box definition
* \param [in] fill_width BOX pattern fill width.
* \param [in] angle1 1st angle for pattern.
* \param [in] pitch1 1st pitch for pattern.
diff --git a/gschem/src/o_bus.c b/gschem/src/o_bus.c
index d9a92bf..7a5f295 100644
--- a/gschem/src/o_bus.c
+++ b/gschem/src/o_bus.c
@@ -136,7 +136,7 @@ void o_bus_draw_stretch (GSCHEM_TOPLEVEL *w_current,
*
* \param [in] w_current The GSCHEM_TOPLEVEL object.
* \param [in] w_x the x position in world coords
- * \param [in] w_x the y position in world coords
+ * \param [in] w_y the y position in world coords
*/
void o_bus_start(GSCHEM_TOPLEVEL *w_current, int w_x, int w_y)
{
@@ -156,7 +156,7 @@ void o_bus_start(GSCHEM_TOPLEVEL *w_current, int w_x, int w_y)
*
* \param [in] w_current The GSCHEM_TOPLEVEL object.
* \param [in] w_x (unused)
- * \param [in] w_x (unused)
+ * \param [in] w_y (unused)
*/
int o_bus_end(GSCHEM_TOPLEVEL *w_current, int w_x, int w_y)
{
diff --git a/gschem/src/o_circle.c b/gschem/src/o_circle.c
index 67c5505..a7e1420 100644
--- a/gschem/src/o_circle.c
+++ b/gschem/src/o_circle.c
@@ -175,10 +175,9 @@ void o_circle_draw(GSCHEM_TOPLEVEL *w_current, OBJECT *o_current)
* \param [in] w GdkDrawable to draw in.
* \param [in] gc GdkGC graphics context to draw on.
* \param [in] color Circle fill color.
- * \param [in] x Center x coordinate of Circle.
- * \param [in] y Center y coordinate of Circle.
- * \param [in] radius Radius of Circle.
- * \param [in] width Circle pattern fill width.
+ * \param [in] w_current Schematic top level
+ * \param [in] circle Circle to be drawn
+ * \param [in] fill_width
* \param [in] angle1 1st angle for pattern.
* \param [in] pitch1 1st pitch for pattern.
* \param [in] angle2 2nd angle for pattern.
@@ -209,10 +208,9 @@ void o_circle_fill_hollow (GdkDrawable *w, GdkGC *gc, COLOR *color,
* \param [in] w GdkDrawable to draw in.
* \param [in] gc GdkGC graphics context to draw on.
* \param [in] color Circle fill color.
- * \param [in] x Center x coordinate of Circle.
- * \param [in] y Center y coordinate of Circle.
- * \param [in] radius Radius of Circle.
- * \param [in] width (unused)
+ * \param [in] w_current Schematic top level
+ * \param [in] circle Circle to be drawn
+ * \param [in] fill_width
* \param [in] angle1 (unused)
* \param [in] pitch1 (unused)
* \param [in] angle2 (unused)
@@ -251,10 +249,9 @@ void o_circle_fill_fill (GdkDrawable *w, GdkGC *gc, COLOR *color,
* \param [in] w GdkDrawable to draw in.
* \param [in] gc GdkGC graphics context to draw on.
* \param [in] color Circle fill color.
- * \param [in] x Center x coordinate of Circle.
- * \param [in] y Center y coordinate of Circle.
- * \param [in] radius Radius of Circle.
- * \param [in] width Circle pattern fill width.
+ * \param [in] w_current Schematic top level
+ * \param [in] circle Circle to be drawn
+ * \param [in] fill_width
* \param [in] angle1 1st angle for pattern.
* \param [in] pitch1 1st pitch for pattern.
* \param [in] angle2 (unused)
@@ -306,10 +303,9 @@ void o_circle_fill_hatch (GdkDrawable *w, GdkGC *gc, COLOR *color,
* \param [in] w GdkDrawable to draw in.
* \param [in] gc GdkGC graphics context to draw on.
* \param [in] color Circle fill color.
- * \param [in] x Center x coordinate of Circle.
- * \param [in] y Center y coordinate of Circle.
- * \param [in] radius Radius of Circle.
- * \param [in] width Circle pattern fill width.
+ * \param [in] w_current Schematic top level
+ * \param [in] circle Circle to be drawn
+ * \param [in] fill_width
* \param [in] angle1 1st angle for pattern.
* \param [in] pitch1 1st pitch for pattern.
* \param [in] angle2 2nd angle for pattern.
diff --git a/gschem/src/o_find.c b/gschem/src/o_find.c
index 65b55d7..db2ae72 100644
--- a/gschem/src/o_find.c
+++ b/gschem/src/o_find.c
@@ -83,7 +83,6 @@ static gboolean find_single_object (GSCHEM_TOPLEVEL *w_current, OBJECT *object,
* through any objects on top of each other at this location.
*
* \param [in] w_current The GSCHEM_TOPLEVEL object.
- * \param [in] object The OBJECT being hit-tested.
* \param [in] w_x The X coordinate to test (in world coords).
* \param [in] w_y The Y coordinate to test (in world coords).
* \param [in] change_selection Whether to select the found object or not.
diff --git a/gschem/src/o_grips.c b/gschem/src/o_grips.c
index 36b421f..1b7f78a 100644
--- a/gschem/src/o_grips.c
+++ b/gschem/src/o_grips.c
@@ -876,7 +876,7 @@ void o_grips_start_picture(GSCHEM_TOPLEVEL *w_current, OBJECT *o_current,
* (<B>w_current->first_wx</B>,<B>w_current->first_wy</B>). They are not suppose
* to change during the action.
*
- * The radius of the circle is stored in <B>w_current->distance<B>.
+ * The radius of the circle is stored in <B>w_current->distance</B>.
*
* \param [in] w_current The GSCHEM_TOPLEVEL object.
* \param [in] o_current Circle OBJECT to check.
@@ -1581,8 +1581,8 @@ int o_grips_size(GSCHEM_TOPLEVEL *w_current)
* <B>x</B> and <B>y</B> are in screen unit.
*
* \param [in] w_current The GSCHEM_TOPLEVEL object.
- * \param [in] x Center x world coordinate for drawing grip.
- * \param [in] y Center y world coordinate for drawing grip.
+ * \param [in] wx Center x world coordinate for drawing grip.
+ * \param [in] wy Center y world coordinate for drawing grip.
*/
void o_grips_draw(GSCHEM_TOPLEVEL *w_current, int wx, int wy)
{
diff --git a/gschem/src/o_line.c b/gschem/src/o_line.c
index f41d4e2..2d9ac27 100644
--- a/gschem/src/o_line.c
+++ b/gschem/src/o_line.c
@@ -273,7 +273,7 @@ void o_line_draw_grips(GSCHEM_TOPLEVEL *w_current, OBJECT *o_current)
/*! \brief
* \par Function Description
*
- * \param [in] toplevel The TOPLEVEL object.
+ * \param [in] w_current The TOPLEVEL object.
* \param [in] line
* \param [in] x1
* \param [in] y1
diff --git a/gschem/src/o_misc.c b/gschem/src/o_misc.c
index 93275ff..a0f652a 100644
--- a/gschem/src/o_misc.c
+++ b/gschem/src/o_misc.c
@@ -487,7 +487,7 @@ int skiplast;
* \brief
* \par Function Description
*
- * \fixme Only descends into the first source schematic
+ * \todo Only descends into the first source schematic
*
*/
int o_edit_find_text (GSCHEM_TOPLEVEL *w_current, const GList *o_list,
diff --git a/gschem/src/o_path.c b/gschem/src/o_path.c
index fc0140e..496a13c 100644
--- a/gschem/src/o_path.c
+++ b/gschem/src/o_path.c
@@ -163,6 +163,7 @@ static PATH *path_copy_modify (PATH *path, int dx, int dy,
* \param [in] w GdkDrawable to draw in.
* \param [in] gc GdkGC graphics context to draw on.
* \param [in] color Box fill color.
+ * \param [in] w_current Schematic top level
* \param [in] path The PATH object to draw
* \param [in] fill_width PATH pattern fill width.
* \param [in] angle1 1st angle for pattern.
@@ -189,6 +190,7 @@ static void o_path_fill_hollow (GdkDrawable *w, GdkGC *gc, COLOR *color,
* \param [in] w GdkDrawable to draw in.
* \param [in] gc GdkGC graphics context to draw on.
* \param [in] color Box fill color.
+ * \param [in] w_current Schematic top level
* \param [in] path The PATH object to draw
* \param [in] fill_width PATH pattern fill width.
* \param [in] angle1 (unused)
@@ -217,6 +219,7 @@ static void o_path_fill_fill (GdkDrawable *w, GdkGC *gc, COLOR *color,
* \param [in] w GdkDrawable to draw in.
* \param [in] gc GdkGC graphics context to draw on.
* \param [in] color Box fill color.
+ * \param [in] w_current Schematic top level
* \param [in] path The PATH object to draw
* \param [in] fill_width PATH pattern fill width.
* \param [in] angle1 1st angle for pattern.
@@ -263,6 +266,7 @@ static void o_path_fill_hatch (GdkDrawable *w, GdkGC *gc, COLOR *color,
* \param [in] w GdkDrawable to draw in.
* \param [in] gc GdkGC graphics context to draw on.
* \param [in] color Box fill color.
+ * \param [in] w_current Schematic top level
* \param [in] path The PATH object to draw
* \param [in] fill_width PATH pattern fill width.
* \param [in] angle1 1st angle for pattern.
diff --git a/gschem/src/o_select.c b/gschem/src/o_select.c
index d9153f0..6778a2a 100644
--- a/gschem/src/o_select.c
+++ b/gschem/src/o_select.c
@@ -511,7 +511,7 @@ int o_select_selected(GSCHEM_TOPLEVEL *w_current)
* \par Unselects all objects in the given list, does the
* needed work to make the objects visually unselected, and redraw them.
* \param [in] w_current GSCHEM_TOPLEVEL struct.
- * \param [in] head Pointer to the selection list
+ * \param [in] selection Pointer to the selection list
*/
void o_select_unselect_list(GSCHEM_TOPLEVEL *w_current, SELECTION *selection)
{
diff --git a/gschem/src/x_compselect.c b/gschem/src/x_compselect.c
index 7e39e1c..ab6be05 100644
--- a/gschem/src/x_compselect.c
+++ b/gschem/src/x_compselect.c
@@ -689,7 +689,7 @@ compselect_callback_filter_entry_changed (GtkEditable *editable,
* It resets the filter entry, indirectly causing re-evaluation
* of the filter on the list of symbols to update the display.
*
- * \param [in] editable The filter text entry.
+ * \param [in] button The clear button
* \param [in] user_data The component selection dialog.
*/
static void
diff --git a/gschem/src/x_dialog.c b/gschem/src/x_dialog.c
index 54992e5..ff14ec2 100644
--- a/gschem/src/x_dialog.c
+++ b/gschem/src/x_dialog.c
@@ -2435,6 +2435,10 @@ char *index2functionstring(int index)
* Cell layout data function to support color swatches in the color
* combobox.
*
+ * \param layout
+ * \param cell
+ * \param model
+ * \param iter
* \param data the current #GSCHEM_TOPLEVEL pointer.
*/
static void
@@ -2461,6 +2465,7 @@ color_menu_swatch_layout_data (GtkCellLayout *layout,
* Update application state to reflect color combobox selection
* changes.
*
+ * \param widget
* \param data the current #GSCHEM_TOPLEVEL pointer.
*/
static void
@@ -3585,7 +3590,7 @@ close_confirmation_dialog_init (CloseConfirmationDialog *self)
* This function determines the number of pages with unsaved changes
* from the model.
*
- * \param in model The tree model.
+ * \param [in] model The tree model.
* \returns The number of pages with unsaved changes.
*/
static gint
@@ -3613,8 +3618,8 @@ count_pages (GtkTreeModel *model)
*
* The returned value must be freed by caller.
*
- * \param in model The tree model.
- * \param in piter A pointer on a GtkTreeIter of model or NULL.
+ * \param [in] model The tree model.
+ * \param [in] piter A pointer on a GtkTreeIter of model or NULL.
* \returns The name for the page.
*/
static gchar*
@@ -3643,12 +3648,12 @@ get_page_name (GtkTreeModel *model, GtkTreeIter *piter)
* This functions sets the cell of the treeview with the short name
* of the page obtained with <B>get_page_name()</B>.
*
- * \param in tree_column A GtkTreeColumn.
- * \param in cell The GtkCellRenderer that is being rendered by
+ * \param [in] tree_column A GtkTreeColumn.
+ * \param [in] cell The GtkCellRenderer that is being rendered by
* tree_column.
- * \param in tree_model The GtkTreeModel being rendered.
- * \param in iter A GtkTreeIter of the current row rendered.
- * \param in data .
+ * \param [in] tree_model The GtkTreeModel being rendered.
+ * \param [in] iter A GtkTreeIter of the current row rendered.
+ * \param [in] data .
*/
static void
close_confirmation_dialog_set_page_name (GtkTreeViewColumn *tree_column,
@@ -3673,9 +3678,9 @@ close_confirmation_dialog_set_page_name (GtkTreeViewColumn *tree_column,
* for the affected row when user toggles the check box in the
* treeview.
*
- * \param in cell_renderer The GtkCellRendererToggle.
- * \param in path The GtkTreePath to the concerned row in model.
- * \param in user The dialog as user data.
+ * \param [in] cell_renderer The GtkCellRendererToggle.
+ * \param [in] path The GtkTreePath to the concerned row in model.
+ * \param [in] user_data The dialog as user data.
*/
static void
close_confirmation_dialog_callback_renderer_toggled (GtkCellRendererToggle *cell_renderer,
@@ -3706,7 +3711,7 @@ close_confirmation_dialog_callback_renderer_toggled (GtkCellRendererToggle *cell
*
* The treeview displays the page names with check boxes.
*
- * \param in dialog The dialog.
+ * \param [in] dialog The dialog.
* \returns A pointer on the GtkVBox to add to dialog.
*/
static GtkWidget*
@@ -4027,10 +4032,10 @@ close_confirmation_dialog_get_property (GObject *object,
* action has been requested. Each selected page is appended to the
* GList pointed by <B>data</B>
*
- * \param in model The tree model.
- * \param in path .
- * \param in iter .
- * \param in data A pointer on a GList* to fill.
+ * \param [in] model The tree model.
+ * \param [in] path .
+ * \param [in] iter .
+ * \param [in] data A pointer on a GList* to fill.
* \returns FALSE to continue walking the tree.
*/
static gboolean
@@ -4061,7 +4066,7 @@ get_selected_pages (GtkTreeModel *model,
*
* The returned list must be freed.
*
- * \param in dialog The dialog.
+ * \param [in] dialog The dialog.
* \returns A GList of selected PAGE* in dialog.
*/
GList*
@@ -4086,8 +4091,8 @@ close_confirmation_dialog_get_selected_pages (CloseConfirmationDialog *dialog)
* closing, or to discard the changes or to save the changes to a
* file.
*
- * \param in toplevel The toplevel environment.
- * \param in page The page to close.
+ * \param [in] w_current The toplevel environment.
+ * \param [in] page The page to close.
*/
void
x_dialog_close_changed_page (GSCHEM_TOPLEVEL *w_current, PAGE *page)
@@ -4156,7 +4161,7 @@ x_dialog_close_changed_page (GSCHEM_TOPLEVEL *w_current, PAGE *page)
* window. Otherwise the user has somehow cancelled and the window
* must not be closed.
*
- * \param in toplevel The toplevel environment.
+ * \param [in] w_current The toplevel environment.
* \returns TRUE if the window can be closed, FALSE otherwise.
*/
gboolean
diff --git a/gschem/src/x_fileselect.c b/gschem/src/x_fileselect.c
index 46c3ea6..c63f5d7 100644
--- a/gschem/src/x_fileselect.c
+++ b/gschem/src/x_fileselect.c
@@ -313,7 +313,7 @@ x_fileselect_save (GSCHEM_TOPLEVEL *w_current)
* \todo Make this a registered callback function with user data,
* as we'd rather be passed a GSCHEM_TOPLEVEL than a TOPLEVEL.
*
- * \param [in] toplevel The TOPLEVEL object.
+ * \param [in] user_data The TOPLEVEL object.
* \param [in] message Message to display to user.
* \return TRUE if the user wants to load the backup file, FALSE otherwise.
*/
diff --git a/gschem/src/x_multiattrib.c b/gschem/src/x_multiattrib.c
index 5e764eb..201b11f 100644
--- a/gschem/src/x_multiattrib.c
+++ b/gschem/src/x_multiattrib.c
@@ -1691,7 +1691,7 @@ static void multiattrib_show_inherited_toggled (GtkToggleButton *button,
* GType instance initialiser for Multiattrib. Create
* and setup the widgets which make up the dialog.
*
- * \param [in] dialog The Multiattrib we are initialising
+ * \param [in] multiattrib The Multiattrib we are initialising
*/
static void multiattrib_init(Multiattrib *multiattrib)
{
diff --git a/gschem/src/x_pagesel.c b/gschem/src/x_pagesel.c
index 1de297f..15385c9 100644
--- a/gschem/src/x_pagesel.c
+++ b/gschem/src/x_pagesel.c
@@ -301,8 +301,8 @@ static void pagesel_popup_menu (Pagesel *pagesel,
* When the gschem-toplevel property is set on the parent GschemDialog,
* we should update the pagesel dialog.
*
- * \param [in] pspec the GParamSpec of the property which changed
* \param [in] gobject the object which received the signal.
+ * \param [in] arg1 the GParamSpec of the property which changed
* \param [in] user_data user data set when the signal handler was connected.
*/
static void notify_gschem_toplevel_cb (GObject *gobject,
diff --git a/gschem/src/x_window.c b/gschem/src/x_window.c
index 283fae1..714183e 100644
--- a/gschem/src/x_window.c
+++ b/gschem/src/x_window.c
@@ -179,6 +179,7 @@ void x_window_setup_draw_events(GSCHEM_TOPLEVEL *w_current)
* falls back to the bitmap icons provided in the distribution.
*
* \param stock Name of the stock icon ("new", "open", etc.)
+ * \param w_current Schematic top level
* \return Pointer to the new GtkImage object.
*/
static GtkWidget *x_window_stock_pixmap(const char *stock, GSCHEM_TOPLEVEL *w_current)
@@ -683,7 +684,7 @@ void x_window_close_all(GSCHEM_TOPLEVEL *w_current)
*
* The opened page becomes the current page of <B>toplevel</B>.
*
- * \param [in] toplevel The toplevel environment.
+ * \param [in] w_current The toplevel environment.
* \param [in] filename The name of the file to open or NULL for a blank page.
* \returns A pointer on the new page.
*
@@ -788,8 +789,8 @@ x_window_open_page (GSCHEM_TOPLEVEL *w_current, const gchar *filename)
*
* <B>page</B> has to be in the list of PAGEs attached to <B>toplevel</B>.
*
- * \param [in] toplevel The toplevel environment.
- * \param [in] page The page to become current page.
+ * \param [in] w_current The toplevel environment.
+ * \param [in] page The page to become current page.
*/
void
x_window_set_current_page (GSCHEM_TOPLEVEL *w_current, PAGE *page)
@@ -828,9 +829,9 @@ x_window_set_current_page (GSCHEM_TOPLEVEL *w_current, PAGE *page)
* <B>page</B> may not be the current page of <B>toplevel</B>. The
* current page of <B>toplevel</B> is not affected by this function.
*
- * \param [in] toplevel The toplevel environment.
- * \param [in] page The page to save.
- * \param [in] filename The name of the file in which to save page.
+ * \param [in] w_current The toplevel environment.
+ * \param [in] page The page to save.
+ * \param [in] filename The name of the file in which to save page.
* \returns 1 on success, 0 otherwise.
*/
gint
@@ -897,8 +898,8 @@ x_window_save_page (GSCHEM_TOPLEVEL *w_current, PAGE *page, const gchar *filenam
* If necessary, the current page of <B>toplevel</B> is changed to
* the next valid page or to a new untitled page.
*
- * \param [in] toplevel The toplevel environment.
- * \param [in] page The page to close.
+ * \param [in] w_current The toplevel environment.
+ * \param [in] page The page to close.
*/
void
x_window_close_page (GSCHEM_TOPLEVEL *w_current, PAGE *page)
@@ -965,7 +966,7 @@ x_window_close_page (GSCHEM_TOPLEVEL *w_current, PAGE *page)
*
* \par Function Description
* Sets the default window icon by name, to be found in the current icon
- * theme. The name used is #defined above as GSCHEM_THEME_ICON_NAME.
+ * theme. The name used is \#defined above as GSCHEM_THEME_ICON_NAME.
*/
void x_window_set_default_icon( void )
{
_______________________________________________
geda-cvs mailing list
geda-cvs@xxxxxxxxxxxxxx
http://www.seul.org/cgi-bin/mailman/listinfo/geda-cvs