[Author Prev][Author Next][Thread Prev][Thread Next][Author Index][Thread Index]
gEDA-cvs: gaf.git: branch: master updated (1.5.0-20080706-255-gf7b1d8d)
The branch, master has been updated
via f7b1d8d15b0e7679332f4ab3695676aba0f890fd (commit)
via 8898cd06ea5e7faffe349fcf6cba4660f6557d18 (commit)
via bbb3342a28c451bc40b7fa5406e5698ee3433dcb (commit)
from d4c19f00f07050376c4ddac731d7569983a1817d (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
=========
libgeda/src/f_print.c | 1 +
libgeda/src/geda_list.c | 11 +++-
libgeda/src/o_arc_basic.c | 11 ++-
libgeda/src/o_attrib.c | 39 +++++-----
libgeda/src/o_basic.c | 17 +++--
libgeda/src/o_box_basic.c | 31 ++-------
libgeda/src/o_circle_basic.c | 19 ++++-
libgeda/src/o_complex_basic.c | 154 +++++++++++++++++++++++++++++++----------
libgeda/src/o_line_basic.c | 23 ++++---
libgeda/src/o_picture.c | 13 ++--
libgeda/src/o_text_basic.c | 2 +-
libgeda/src/s_clib.c | 2 +-
libgeda/src/s_conn.c | 2 +-
13 files changed, 214 insertions(+), 111 deletions(-)
=================
Commit Messages
=================
commit f7b1d8d15b0e7679332f4ab3695676aba0f890fd
Author: Werner Hoch <werner.ho@xxxxxx>
Date: Sun Oct 26 18:06:10 2008 +0100
doxygen: misc fixes of doxygen warnings
:100644 100644 10752f0... 1f268c2... M libgeda/src/f_print.c
:100644 100644 b6792c6... baf939e... M libgeda/src/geda_list.c
:100644 100644 7f8d5c4... 338f996... M libgeda/src/o_arc_basic.c
:100644 100644 f2a6ffa... 11eb417... M libgeda/src/o_attrib.c
:100644 100644 2c9f80a... 8078a1c... M libgeda/src/o_basic.c
:100644 100644 f78b101... 9693e8b... M libgeda/src/o_circle_basic.c
:100644 100644 3fd3ef8... c0fab50... M libgeda/src/o_line_basic.c
:100644 100644 16f92e4... b61ff5c... M libgeda/src/o_picture.c
:100644 100644 b8190c5... 21d36a5... M libgeda/src/o_text_basic.c
:100644 100644 9351b85... fef4e71... M libgeda/src/s_clib.c
:100644 100644 677c7cd... 655cb48... M libgeda/src/s_conn.c
commit 8898cd06ea5e7faffe349fcf6cba4660f6557d18
Author: Werner Hoch <werner.ho@xxxxxx>
Date: Sun Oct 26 17:35:13 2008 +0100
doxygen: documentation for libgeda o_complex_basic.c
:100644 100644 40ef318... b33fd0b... M libgeda/src/o_complex_basic.c
commit bbb3342a28c451bc40b7fa5406e5698ee3433dcb
Author: Werner Hoch <werner.ho@xxxxxx>
Date: Sun Oct 26 15:12:38 2008 +0100
libgeda: removed unused box macros in o_box_basic.c
:100644 100644 b7a32f4... 6d16e55... M libgeda/src/o_box_basic.c
=========
Changes
=========
commit f7b1d8d15b0e7679332f4ab3695676aba0f890fd
Author: Werner Hoch <werner.ho@xxxxxx>
Date: Sun Oct 26 18:06:10 2008 +0100
doxygen: misc fixes of doxygen warnings
diff --git a/libgeda/src/f_print.c b/libgeda/src/f_print.c
index 10752f0..1f268c2 100644
--- a/libgeda/src/f_print.c
+++ b/libgeda/src/f_print.c
@@ -87,6 +87,7 @@ void f_print_set_color(FILE *fp, int color)
* \param [in] fp The postscript document to write to.
* \param [in] paper_size_x The width of the document on paper in inches.
* \param [in] paper_size_y The height of the document on paper in inches.
+ * \param [in] eps whether to create a eps of a ps document
* \return 0 on success, -1 on failure.
*/
int f_print_header(TOPLEVEL *toplevel, FILE *fp,
diff --git a/libgeda/src/geda_list.c b/libgeda/src/geda_list.c
index b6792c6..baf939e 100644
--- a/libgeda/src/geda_list.c
+++ b/libgeda/src/geda_list.c
@@ -18,6 +18,12 @@
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111 USA
*/
+/*! \file geda_list.c
+ * \brief list derived from GList with GObject properties
+ *
+ * This GedaList with the GObject properties can use the signaling
+ * mechanisms of GObject now.
+ */
#include <config.h>
@@ -62,7 +68,7 @@ static void geda_list_instance_init( GTypeInstance *instance, gpointer g_class )
* Just before the GedaList 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 geda_list_finalize( GObject *object )
{
@@ -79,7 +85,8 @@ static void geda_list_finalize( GObject *object )
* GType class initialiser for GedaList. We override our parents
* virtual class methods as needed and register our GObject signals.
*
- * \param [in] klass The GedaList we are initialising
+ * \param [in] g_class The GedaList we are initialising
+ * \param [in] g_class_data (unused)
*/
static void geda_list_class_init( gpointer g_class, gpointer g_class_data )
{
diff --git a/libgeda/src/o_arc_basic.c b/libgeda/src/o_arc_basic.c
index 7f8d5c4..338f996 100644
--- a/libgeda/src/o_arc_basic.c
+++ b/libgeda/src/o_arc_basic.c
@@ -17,6 +17,11 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111 USA
*/
+
+/*! \file o_arc_basic.c
+ * \brief functions for the arc object
+ */
+
#include <config.h>
#include <stdio.h>
@@ -1232,10 +1237,10 @@ void o_arc_print_phantom(TOPLEVEL *toplevel, FILE *fp,
/*! \brief Calculates the distance between the given point and the closest
* point on the perimeter of the arc.
*
- * \param [in] object The object, where object->arc != NULL.
+ * \param [in] arc the arc of the OBJECT
* \param [in] x The x coordinate of the given point.
* \param [in] y The y coordinate of the given point.
- * \return The shortest distance from the object to the point. With an
+ * \return The shortest distance from the object to the point. With an
* invalid parameter, this function returns G_MAXDOUBLE.
*/
gdouble o_arc_shortest_distance(ARC *arc, gint x, gint y)
@@ -1291,7 +1296,7 @@ gdouble o_arc_shortest_distance(ARC *arc, gint x, gint y)
/*! \brief Determines if a point lies within the sweep of the arc.
*
- * \param [in] object The object, where object->arc != NULL.
+ * \param [in] arc The arc of object
* \param [in] x The x coordinate of the given point.
* \param [in] y The y coordinate of the given point.
* \return TRUE if the point lies within the sweep of the arc.
diff --git a/libgeda/src/o_attrib.c b/libgeda/src/o_attrib.c
index f2a6ffa..11eb417 100644
--- a/libgeda/src/o_attrib.c
+++ b/libgeda/src/o_attrib.c
@@ -17,6 +17,24 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111 USA
*/
+
+/*! \file o_attrib.c
+ * \brief utility functions for attributes
+ *
+ * Attributes are normal text objects. An attribute is a text object
+ * that has a text string that is delimited by an equal "=" character.
+ * The part before the equal character is called <b>name</b> the
+ * part of the string behind the equal character is called <b>value</b>
+ *
+ * Attributes are can be attached to OBJECTs (st_object).
+ *
+ * \note
+ * Be sure in o_copy o_move o_delete you maintain the attributes
+ * delete is a bare, because you will have to unattach the other end
+ * and in o_save o_read as well
+ * and in o_select when selecting objects, select the attributes
+ */
+
#include <config.h>
#include <stdio.h>
@@ -34,29 +52,13 @@
/*! Basic string splitting delimiters */
#define DELIMITERS ",; "
-/*! \note
- * No special type for attributes
- * You can only edit text attributes
- *
- * be sure in o_copy o_move o_delete you maintain the attributes
- * delete is a bare, because you will have to unattach the other end
- * and in o_save o_read as well
- * and in o_select when selecting objects, select the attributes
- *
- * \todo there needs to be a modifier (in struct.h, such as a flag) which
- * signifies that this is an attribute (really? why?)
- *
- * \note
- * return pointer from attrib_list
- */
-
-
/*! \brief Search for an item in an attribute list.
* \par Function Description
* Search for an item in an attribute list.
*
* \param [in] list list to be searched.
* \param [in] item item to be found.
+ * \return the object item if it is found, NULL otherwise
*/
OBJECT *o_attrib_search(GList *list, OBJECT *item)
{
@@ -86,7 +88,7 @@ OBJECT *o_attrib_search(GList *list, OBJECT *item)
* Add an attribute to an existing attribute list.
*
* \param [in] toplevel The TOPLEVEL object.
- * \param [in] list_head The OBJECT we're adding the attribute to.
+ * \param [in] object The OBJECT we're adding the attribute to.
* \param [in] item The item you want to add as an attribute.
* \return The new head of the attributes list.
*/
@@ -432,7 +434,6 @@ OBJECT *o_read_attribs(TOPLEVEL *toplevel,
* Saves a list of attributes int a buffer in libgeda, including the
* attribute list start and end markers.
*
- * \param [in] fp FILE pointer to write attributes to.
* \param [in] attribs attributes to write.
* \todo
* this should be trimmed down to only save attributes which are text items
diff --git a/libgeda/src/o_basic.c b/libgeda/src/o_basic.c
index 2c9f80a..8078a1c 100644
--- a/libgeda/src/o_basic.c
+++ b/libgeda/src/o_basic.c
@@ -17,6 +17,17 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111 USA
*/
+
+/*! \file o_basic.c
+ * \brief functions for the basic object type
+ *
+ * This file contains the code used to handle OBJECTs (st_object).
+ * \todo improve doc, draw some design images.
+ * \todo
+ * Lots of Gross code... needs lots of cleanup
+ * mainly readability issues
+ */
+
#include <config.h>
#include <stdio.h>
@@ -36,10 +47,6 @@
/*! Default setting for object selection function. */
void (*select_func)() = NULL;
-/* \todo
- * Lots of Gross code... needs lots of cleanup
- * mainly readability issues
- */
/*! \brief Check if point is inside a region
* \par Function Description
@@ -267,7 +274,7 @@ void o_set_fill_options(TOPLEVEL *toplevel, OBJECT *o_current,
*
* \param [in] toplevel The toplevel environment.
* \param [in] dx Amount to horizontally translate object
- * \param [in] dx Amount to vertically translate object
+ * \param [in] dy Amount to vertically translate object
* \param [in] object The object to translate.
*/
void o_translate_world (TOPLEVEL *toplevel, gint dx, gint dy, OBJECT *object)
diff --git a/libgeda/src/o_circle_basic.c b/libgeda/src/o_circle_basic.c
index f78b101..9693e8b 100644
--- a/libgeda/src/o_circle_basic.c
+++ b/libgeda/src/o_circle_basic.c
@@ -17,6 +17,11 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111 USA
*/
+
+/*! \file o_circle_basic.c
+ * \brief functions for the circle object
+ */
+
#include <config.h>
#include <stdio.h>
#include <math.h>
@@ -30,9 +35,17 @@
/*! Default setting for circle draw function. */
void (*circle_draw_func)() = NULL;
-/*! \brief
+/*! \brief calculate the distance between two points
* \par Function Description
- *
+ * This function calculates the distance between two points.
+ * The two points are defined by the (\a x1, \a y1) and (\a x2, \a y2)
+ * parameters.
+ * \param [in] x1 x-value of the first point
+ * \param [in] y1 y-value of the first point
+ * \param [in] x2 x-value of the second point
+ * \param [in] y2 y-value of the second point
+ * \return the distance
+ * \todo Move this function to a different place
*/
int dist(int x1, int y1, int x2, int y2)
{
@@ -1096,7 +1109,7 @@ void o_circle_print_hatch(TOPLEVEL *toplevel, FILE *fp,
/*! \brief Calculates the distance between the given point and the closest
* point on the perimeter of the circle.
*
- * \param [in] object The object, where object->circle != NULL.
+ * \param [in] circle The circle of the OBJECT
* \param [in] x The x coordinate of the given point.
* \param [in] y The y coordinate of the given point.
* \return The shortest distance from the object to the point. With an
diff --git a/libgeda/src/o_line_basic.c b/libgeda/src/o_line_basic.c
index 3fd3ef8..c0fab50 100644
--- a/libgeda/src/o_line_basic.c
+++ b/libgeda/src/o_line_basic.c
@@ -17,6 +17,11 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111 USA
*/
+
+/*! \file o_line_basic.c
+ * \brief functions for the line object
+ */
+
#include <config.h>
#include <stdio.h>
@@ -170,9 +175,6 @@ OBJECT *o_line_copy(TOPLEVEL *toplevel, OBJECT *o_current)
* <DT>*</DT><DD>LINE_END1
* <DT>*</DT><DD>LINE_END2
* </DL>
- *
- * \par Author's note
- * pb20011009 - modified
*/
void o_line_modify(TOPLEVEL *toplevel, OBJECT *object,
int x, int y, int whichone)
@@ -398,7 +400,7 @@ void o_line_rotate_world(TOPLEVEL *toplevel,
int newx, newy;
if (angle == 0)
- return;
+ return;
/* angle must be positive */
if(angle < 0) angle = -angle;
@@ -493,7 +495,7 @@ void o_line_recalc(TOPLEVEL *toplevel, OBJECT *o_current)
* in <B>*line</B> in world units.
*
* \param [in] toplevel The TOPLEVEL object.
- * \param [in] OBJECT Line OBJECT to read coordinates from.
+ * \param [in] object Line OBJECT to read coordinates from.
* \param [out] left Left line coordinate in WORLD units.
* \param [out] top Top line coordinate in WORLD units.
* \param [out] right Right line coordinate in WORLD units.
@@ -1192,11 +1194,12 @@ int o_line_visible(TOPLEVEL *toplevel, LINE *line,
return(visible);
}
-/*! \brief
+/*! \brief calculate the lenght of a line object
* \par Function Description
+ * This function calculates the length of a line object
*
- * \param [in] object
- * \return double
+ * \param [in] object a line OBJECT
+ * \return The length of the line
*/
double o_line_length(OBJECT *object)
{
@@ -1222,10 +1225,10 @@ double o_line_length(OBJECT *object)
* end point, this function returns the distance from the given point to the
* closest end point.
*
- * \param [in] object The object, where object->line != NULL.
+ * \param [in] line The line of an OBJECT
* \param [in] x The x coordinate of the given point.
* \param [in] y The y coordinate of the given point.
- * \return The shortest distance from the object to the point. With an
+ * \return The shortest distance from the object to the point. With an
* invalid parameter, this function returns G_MAXDOUBLE.
*/
gdouble o_line_shortest_distance(LINE *line, gint x, gint y)
diff --git a/libgeda/src/o_picture.c b/libgeda/src/o_picture.c
index 16f92e4..b61ff5c 100644
--- a/libgeda/src/o_picture.c
+++ b/libgeda/src/o_picture.c
@@ -17,6 +17,11 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111 USA
*/
+
+/*! \file o_picture.c
+ * \brief functions for the picture object
+ */
+
#include <config.h>
#include <stdio.h>
@@ -664,7 +669,7 @@ void o_picture_translate_world(TOPLEVEL *toplevel,
* <B>o_current</B> describing a picture.
*
* \param [in] toplevel The TOPLEVEL object.
- * \param [in] objcet Picture OBJECT to copy.
+ * \param [in] object Picture OBJECT to copy.
* \return The new OBJECT
*/
OBJECT *o_picture_copy(TOPLEVEL *toplevel, OBJECT *object)
@@ -882,8 +887,6 @@ void o_picture_print(TOPLEVEL *toplevel, FILE *fp, OBJECT *o_current,
g_free(rgb_data);
g_free(mask_data);
-
-
}
@@ -1027,10 +1030,10 @@ GdkPixbuf *o_picture_pixbuf_from_buffer (gchar *file_content,
*
* Interrior points within the picture return a distance of zero.
*
- * \param [in] object The object, where object->picture != NULL.
+ * \param [in] picture the picture of the OBJECT
* \param [in] x The x coordinate of the given point.
* \param [in] y The y coordinate of the given point.
- * \return The shortest distance from the object to the point. With an
+ * \return The shortest distance from the object to the point. With an
* invalid parameter, this function returns G_MAXDOUBLE.
*/
gdouble o_picture_shortest_distance(PICTURE *picture, gint x, gint y)
diff --git a/libgeda/src/o_text_basic.c b/libgeda/src/o_text_basic.c
index b8190c5..21d36a5 100644
--- a/libgeda/src/o_text_basic.c
+++ b/libgeda/src/o_text_basic.c
@@ -1825,7 +1825,7 @@ void o_text_mirror_world(TOPLEVEL *toplevel,
* This function will calculate the distance to the text regardless
* if the text is visible or not.
*
- * \param [in] object The object, where object->text != NULL.
+ * \param [in] text the text of the OBJECT
* \param [in] x The x coordinate of the given point.
* \param [in] y The y coordinate of the given point.
* \return The shortest distance from the object to the point. If the
diff --git a/libgeda/src/s_clib.c b/libgeda/src/s_clib.c
index 9351b85..fef4e71 100644
--- a/libgeda/src/s_clib.c
+++ b/libgeda/src/s_clib.c
@@ -441,7 +441,7 @@ static void cache_find_oldest (gpointer key,
*
* \todo This is probably generally useful.
*
- * \param argv Command string to execute.
+ * \param command Command string to execute.
* \return The program's output, or \b NULL on failure.
*/
static gchar *run_source_command (const gchar *command)
diff --git a/libgeda/src/s_conn.c b/libgeda/src/s_conn.c
index 677c7cd..655cb48 100644
--- a/libgeda/src/s_conn.c
+++ b/libgeda/src/s_conn.c
@@ -713,7 +713,7 @@ void s_conn_update_object(TOPLEVEL * toplevel, OBJECT * object)
* This function adds all underlying OBJECTs of a complex OBJECT
* <b>complex</b> into the connection system.
* \param toplevel (currently not used)
- * \param object complex OBJECT to add into the connection system
+ * \param complex complex OBJECT to add into the connection system
*/
void s_conn_update_complex(TOPLEVEL * toplevel, OBJECT * complex)
{
commit 8898cd06ea5e7faffe349fcf6cba4660f6557d18
Author: Werner Hoch <werner.ho@xxxxxx>
Date: Sun Oct 26 17:35:13 2008 +0100
doxygen: documentation for libgeda o_complex_basic.c
diff --git a/libgeda/src/o_complex_basic.c b/libgeda/src/o_complex_basic.c
index 40ef318..b33fd0b 100644
--- a/libgeda/src/o_complex_basic.c
+++ b/libgeda/src/o_complex_basic.c
@@ -17,6 +17,13 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111 USA
*/
+
+/*! \file o_complex_basic.c
+ * \brief Functions for complex objects
+ *
+ * Complex objects are collections of primary objects.
+ */
+
#include <config.h>
#include <stdio.h>
@@ -137,8 +144,8 @@ world_get_object_list_bounds(TOPLEVEL *toplevel, OBJECT *complex,
/*! \brief Return the bounds of the given GList of objects.
* \par Given a list of objects, calcule the bounds coordinates.
- * \param [in] toplevel The toplevel structure.
- * \param [in] complex The list of objects to look the bounds for.
+ * \param [in] toplevel The TOPLEVEL structure.
+ * \param [in] head The list of objects to look the bounds for.
* \param [out] left pointer to the left coordinate of the object.
* \param [out] top pointer to the top coordinate of the object.
* \param [out] right pointer to the right coordinate of the object.
@@ -157,7 +164,7 @@ int world_get_object_glist_bounds(TOPLEVEL *toplevel, GList *head,
s_current = head;
- // Find the first object with bounds, and set the bounds variables, then expand as necessary
+ /* Find the first object with bounds, and set the bounds variables, then expand as necessary */
while ( s_current != NULL ) {
o_current = (OBJECT *) s_current->data;
g_assert (o_current != NULL);
@@ -209,9 +216,12 @@ void world_get_complex_bounds(TOPLEVEL *toplevel, OBJECT *complex,
}
-/*! \brief
+/*! \brief create a new head object
* \par Function Description
- *
+ * This function creates a <b>complex_head</b> OBJECT. This OBJECT
+ * is just a special empty object. This object is never modified.
+ *
+ * \return new head OBJECT
*/
OBJECT *new_head ()
{
@@ -219,14 +229,18 @@ OBJECT *new_head ()
new_node = s_basic_new_object(OBJ_HEAD, "complex_head");
- /* don't need to do this for head nodes */
- /* ret = (OBJECT *) s_basic_link_object(new_node, NULL);*/
return new_node;
}
-/*! \brief
+/*! \brief check whether an object is a attributes
* \par Function Description
+ * This function checks if an object should be promoted.
+ * An attribute object is promotable if it's promoted by default, or the user
+ * has configered it to promote an attribute.
*
+ * \param [in] toplevel The TOPLEVEL object
+ * \param [in] object The attribute object to check
+ * \return TRUE if the object is a eligible attribute, FALSE otherwise
*/
static int o_complex_is_eligible_attribute (TOPLEVEL *toplevel, OBJECT *object)
{
@@ -260,23 +274,25 @@ static int o_complex_is_eligible_attribute (TOPLEVEL *toplevel, OBJECT *object)
return TRUE;
}
-/*! \brief
+/*! \brief get the embedded state of an complex object
* \par Function Description
+ * Checks and returns the status of the complex object.
*
+ * \param o_current The object to check
+ * \return 1 if embedded, 0 otherwise
*/
int o_complex_is_embedded(OBJECT *o_current)
{
g_return_val_if_fail(o_current != NULL, 0);
if(o_current->complex == NULL)
- return 0;
+ return 0;
if (o_current->complex_embedded) {
return 1;
} else {
return 0;
}
-
}
@@ -632,9 +648,20 @@ OBJECT *o_complex_new(TOPLEVEL *toplevel,
return new_node;
}
-/*! \brief
+/*! \brief create a new embedded object
* \par Function Description
+ * This function creates a new embedded object.
*
+ * \param [in] toplevel The TOPLEVEL object
+ * \param [in] type The type of the object (usually OBJ_COMLEX)
+ * \param [in] color The color of the object
+ * \param [in] x The x location of the complex object
+ * \param [in] y The y location of the complex object
+ * \param [in] angle The rotation angle
+ * \param [in] mirror The mirror status
+ * \param [in] basename The basic name the embedded was created of
+ * \param [in] selectable whether the object can be selected with the mouse
+ * \return a new complex object
*/
OBJECT *o_complex_new_embedded(TOPLEVEL *toplevel,
char type, int color, int x, int y, int angle, int mirror,
@@ -682,9 +709,12 @@ OBJECT *o_complex_new_embedded(TOPLEVEL *toplevel,
return new_node;
}
-/*! \brief
+/*! \brief update the visual boundaries of the complex object
* \par Function Description
+ * This function updates the boundaries of the object \a o_current.
*
+ * \param [in] toplevel The TOPLEVEL object
+ * \param [in] o_current The OBJECT to update
*/
void o_complex_recalc(TOPLEVEL *toplevel, OBJECT *o_current)
{
@@ -705,8 +735,18 @@ void o_complex_recalc(TOPLEVEL *toplevel, OBJECT *o_current)
o_current->w_bounds_valid = TRUE;
}
-/*! \brief
+/*! \brief read a complex object from a char buffer
* \par Function Description
+ * This function reads a complex object from the buffer \a buf.
+ * If the complex object was read successfully, a new object is
+ * 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
+ * \return The object list
*
* \todo Don't use fixed-length string for symbol basename
*/
@@ -775,9 +815,13 @@ OBJECT *o_complex_read(TOPLEVEL *toplevel, OBJECT *object_list,
return object_list;
}
-/*! \brief
+/*! \brief Create a string representation of the complex object
* \par Function Description
+ * This function takes a complex \a object and return a string
+ * according to the file format definition.
*
+ * \param [in] object a complex OBJECT
+ * \return the string representation of the complex OBJECT
*/
char *o_complex_save(OBJECT *object)
{
@@ -808,9 +852,14 @@ char *o_complex_save(OBJECT *object)
return(buf);
}
-/*! \brief
+/*! \brief move a complex object
* \par Function Description
+ * This function changes the position of a complex \a object.
*
+ * \param [in] toplevel The TOPLEVEL object
+ * \param [in] dx The x-distance to move the object
+ * \param [in] dy The y-distance to move the object
+ * \param [in] object The complex OBJECT to be moved
*/
void o_complex_translate_world(TOPLEVEL *toplevel, int dx, int dy,
OBJECT *object)
@@ -827,9 +876,13 @@ void o_complex_translate_world(TOPLEVEL *toplevel, int dx, int dy,
o_complex_recalc (toplevel, object);
}
-/*! \brief
+/*! \brief create a copy of a complex object
* \par Function Description
+ * This function creates a copy of the complex object \a o_current.
*
+ * \param [in] toplevel The TOPLEVEL object
+ * \param [in] o_current The object that is copied
+ * \return a new complex object
*/
OBJECT *o_complex_copy(TOPLEVEL *toplevel, OBJECT *o_current)
{
@@ -875,9 +928,13 @@ OBJECT *o_complex_copy(TOPLEVEL *toplevel, OBJECT *o_current)
return new_obj;
}
-/*! \brief
+/*! \brief create a copy of a embedded complex object
* \par Function Description
+ * This function creates a copy of an embedded complex object \a o_current.
*
+ * \param [in] toplevel The TOPLEVEL object
+ * \param [in] o_current The object that is copied
+ * \return a new complex object
*/
OBJECT *o_complex_copy_embedded(TOPLEVEL *toplevel, OBJECT *o_current)
{
@@ -931,9 +988,14 @@ OBJECT *o_complex_copy_embedded(TOPLEVEL *toplevel, OBJECT *o_current)
return new_obj;
}
-/*! \brief
+/*! \brief Change the color of a object list
* \par Function Description
+ * This function changes the the color of a object list
*
+ * \param [in] prim_objs The head object
+ * \param [in] color The new color
+ *
+ * \note This function is mainly used to change the color of text objects
*/
void o_complex_set_color(OBJECT *prim_objs, int color)
{
@@ -971,9 +1033,12 @@ void o_complex_set_color(OBJECT *prim_objs, int color)
}
}
-/*! \brief
+/*! \brief Change the color of a complex object
* \par Function Description
+ * This function changes the color of a complex object \a o_current.
*
+ * \param [in] o_current The OBJECT to change
+ * \param [in] color The new color
*/
void o_complex_set_color_single(OBJECT *o_current, int color)
{
@@ -1007,7 +1072,8 @@ void o_complex_set_color_single(OBJECT *o_current, int color)
}
}
-/*! \brief
+/*! \todo Finish function documentation!!!
+ * \brief
* \par Function Description
*
*/
@@ -1054,7 +1120,8 @@ void o_complex_set_color_save(OBJECT *complex, int color)
}
}
-/*! \brief
+/*! \todo Finish function documentation!!!
+ * \brief
* \par Function Description
*
*/
@@ -1099,7 +1166,8 @@ void o_complex_unset_color(OBJECT *complex)
}
}
-/*! \brief
+/*! \todo Finish function documentation!!!
+ * \brief
* \par Function Description
*
*/
@@ -1137,7 +1205,8 @@ void o_complex_unset_color_single(OBJECT *o_current)
}
}
-/*! \brief
+/*! \todo Finish function documentation!!!
+ * \brief
* \par Function Description
*
*/
@@ -1177,12 +1246,14 @@ void o_complex_set_saved_color_only(OBJECT *complex, int color)
}
}
-/*! \brief
+/*! \brief get the nth pin of a object list
* \par Function Description
- *
+ * Search the nth pin the object list \a o_list and return it.
+ *
+ * \param o_list the object list to search through
+ * \param counter specifies the nth pin
+ * \return the counter'th pin object, NULL if there is no more pin
*/
-/* returns the counter'th pin in o_list */
-/* NULL if there is no more pins */
OBJECT *o_complex_return_nth_pin(OBJECT *o_list, int counter)
{
OBJECT *o_current;
@@ -1286,11 +1357,15 @@ void o_complex_mirror_world(TOPLEVEL *toplevel,
}
-/*! \brief
+/*! \brief search the pin with a given pin number
* \par Function Description
- *
+ * This function searches a pin object inside the complex \a object.
+ * The pin name is a character string \a pin.
+
+ * \param object The complex object
+ * \param pin The pin number (string) to find
+ * \return a pin object if found, NULL otherwise
*/
-/* pass in top level object */
OBJECT *o_complex_return_pin_object(OBJECT *object, char *pin)
{
OBJECT *o_current=NULL;
@@ -1332,10 +1407,9 @@ OBJECT *o_complex_return_pin_object(OBJECT *object, char *pin)
* component object), this fcn iterates through the prim_objs
* list counting the number of pins it finds.
*
- * \param [in] pointer to complex object
+ * \param [in] object pointer to complex object
* \return integer number of pins counted.
*/
-/* pass in top level object */
int o_complex_count_pins(OBJECT *object)
{
OBJECT *o_current=NULL;
@@ -1367,11 +1441,17 @@ int o_complex_count_pins(OBJECT *object)
return(pin_counter);
}
-/*! \brief
+/*! \brief check the symversion of a complex object
* \par Function Description
- *
+ * This function compares the symversion of a symbol with it's
+ * earlier saved symversion in a schematic.
+ * Major symversion changes are added to the toplevel object
+ * (toplevel->major_changed_refdes), minor changes are reported
+ * to the messaging system.
+ *
+ * \param toplevel The TOPLEVEL object
+ * \param object The complex OBJECT
*/
-/* pass in top level object */
void
o_complex_check_symversion(TOPLEVEL* toplevel, OBJECT* object)
{
@@ -1545,7 +1625,7 @@ done:
/*! \brief Calculates the distance between the given point and the closest
* point on an object within the complex object.
*
- * \param [in] object The object, where object->complex != NULL.
+ * \param [in] complex The complex of the OBJECT
* \param [in] x The x coordinate of the given point.
* \param [in] y The y coordinate of the given point.
* \return The shortest distance from the object to the point. If the
commit bbb3342a28c451bc40b7fa5406e5698ee3433dcb
Author: Werner Hoch <werner.ho@xxxxxx>
Date: Sun Oct 26 15:12:38 2008 +0100
libgeda: removed unused box macros in o_box_basic.c
diff --git a/libgeda/src/o_box_basic.c b/libgeda/src/o_box_basic.c
index b7a32f4..6d16e55 100644
--- a/libgeda/src/o_box_basic.c
+++ b/libgeda/src/o_box_basic.c
@@ -17,6 +17,11 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111 USA
*/
+
+/*! \file o_box_basic.c
+ * \brief functions for the box object
+ */
+
#include <config.h>
#include <math.h>
#include <stdio.h>
@@ -27,28 +32,6 @@
#include <dmalloc.h>
#endif
-/* Kazu on July 16, 1999 - Added these macros to simplify the code */
-/*! \brief Returns the box width.
- * Returns the box width.
- */
-#define GET_BOX_WIDTH(w) \
- abs((w)->last_x - (w)->start_x)
-/*! \brief Returns the box height.
- * Returns the box height.
- */
-#define GET_BOX_HEIGHT(w) \
- abs((w)->last_y - (w)->start_y)
-/*! \brief Returns the box left coordinate.
- * Returns the box left coordinate.
- */
-#define GET_BOX_LEFT(w) \
- min((w)->start_x, (w)->last_x);
-/*! \brief Returns the box left coordinate.
- * Returns the box left coordinate.
- */
-#define GET_BOX_TOP(w) \
- min((w)->start_y, (w)->last_y);
-
/*! Default setting for draw function. */
void (*box_draw_func)() = NULL;
@@ -1340,10 +1323,10 @@ void o_box_print_hatch(TOPLEVEL *toplevel, FILE *fp,
/*! \brief Calculates the distance between the given point and the closest
* point on the perimeter of the box.
*
- * \param [in] object The object, where object->box != NULL.
+ * \param [in] box The box of an OBJECT (object->box != NULL).
* \param [in] x The x coordinate of the given point.
* \param [in] y The y coordinate of the given point.
- * \return The shortest distance from the object to the point. With an
+ * \return The shortest distance from the object to the point. With an
* invalid parameter, this function returns G_MAXDOUBLE.
*/
gdouble o_box_shortest_distance(BOX *box, gint x, gint y)
_______________________________________________
geda-cvs mailing list
geda-cvs@xxxxxxxxxxxxxx
http://www.seul.org/cgi-bin/mailman/listinfo/geda-cvs