[Author Prev][Author Next][Thread Prev][Thread Next][Author Index][Thread Index]
gEDA-cvs: gaf.git: branch: master updated (1.5.0-20080706-289-g35c1fad)
The branch, master has been updated
via 35c1fad3cfab34053fcd850e2a0208db54558baf (commit)
via a0bd1fa71f376b01212f655bfdcd9da4fb046868 (commit)
via ad9d7ca705f1135a957d6e76244b164e94328ef1 (commit)
via 2f30918c3ae433204df9149e6b494b32e2db8559 (commit)
from 0b194eee257f5818cc0ad9b035f9b81134a87745 (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/include/prototype_priv.h | 3 -
libgeda/src/g_rc.c | 3 +-
libgeda/src/g_smob.c | 2 +-
libgeda/src/m_hatch.c | 4 +-
libgeda/src/m_transform.c | 8 +-
libgeda/src/o_embed.c | 25 ++-
libgeda/src/o_path_basic.c | 12 +-
libgeda/src/o_selection.c | 2 +-
libgeda/src/o_text_basic.c | 345 ++++++++++++++++++++------------------
libgeda/src/s_page.c | 40 +++---
10 files changed, 234 insertions(+), 210 deletions(-)
=================
Commit Messages
=================
commit 35c1fad3cfab34053fcd850e2a0208db54558baf
Author: Werner Hoch <werner.ho@xxxxxx>
Date: Sun Nov 2 14:59:14 2008 +0100
remove unused print functions from o_text_basic.c
The following functions are obsolete:
o_text_print_text_width,
o_text_print_text_height
o_text_print_text_height_full
They are no longer used since the rework of the postscript code in the
commit 1b6e818196f268a3ea1fca7135e413147a36ed6a by Mike Jarabek
:100644 100644 b60622c... 3c3c64c... M libgeda/include/prototype_priv.h
:100644 100644 1aa54af... 33dab39... M libgeda/src/o_text_basic.c
commit a0bd1fa71f376b01212f655bfdcd9da4fb046868
Author: Werner Hoch <werner.ho@xxxxxx>
Date: Sun Nov 2 14:42:56 2008 +0100
doxygen: documentation for libgeda o_text_basic.c
:100644 100644 d95ebaf... 1aa54af... M libgeda/src/o_text_basic.c
commit ad9d7ca705f1135a957d6e76244b164e94328ef1
Author: Werner Hoch <werner.ho@xxxxxx>
Date: Sun Nov 2 11:13:32 2008 +0100
remove unused defines from o_text_basic.c ...
and move some variables in front of all functions
:100644 100644 21d36a5... d95ebaf... M libgeda/src/o_text_basic.c
commit 2f30918c3ae433204df9149e6b494b32e2db8559
Author: Werner Hoch <werner.ho@xxxxxx>
Date: Tue Oct 28 22:20:36 2008 +0100
doxygen: libgeda: fixed more warnings from the doxygen log
added some documentation, too.
:100644 100644 1292d39... 3aa358b... M libgeda/src/g_rc.c
:100644 100644 98d0083... 5b15ede... M libgeda/src/g_smob.c
:100644 100644 f61e748... 612ed62... M libgeda/src/m_hatch.c
:100644 100644 260781e... 142e27e... M libgeda/src/m_transform.c
:100644 100644 a1cd97b... eaf0428... M libgeda/src/o_embed.c
:100644 100644 730f459... 41c8d51... M libgeda/src/o_path_basic.c
:100644 100644 1ba3bf6... 616353f... M libgeda/src/o_selection.c
:100644 100644 52cd7ad... 39923ee... M libgeda/src/s_page.c
=========
Changes
=========
commit 35c1fad3cfab34053fcd850e2a0208db54558baf
Author: Werner Hoch <werner.ho@xxxxxx>
Date: Sun Nov 2 14:59:14 2008 +0100
remove unused print functions from o_text_basic.c
The following functions are obsolete:
o_text_print_text_width,
o_text_print_text_height
o_text_print_text_height_full
They are no longer used since the rework of the postscript code in the
commit 1b6e818196f268a3ea1fca7135e413147a36ed6a by Mike Jarabek
diff --git a/libgeda/include/prototype_priv.h b/libgeda/include/prototype_priv.h
index b60622c..3c3c64c 100644
--- a/libgeda/include/prototype_priv.h
+++ b/libgeda/include/prototype_priv.h
@@ -200,9 +200,6 @@ OBJECT *o_text_read(TOPLEVEL *toplevel,
unsigned int release_ver,
unsigned int fileformat_ver);
char *o_text_save(OBJECT *object);
-void o_text_print_text_width(FILE *fp, char *output_string);
-void o_text_print_text_height(FILE *fp, int size);
-void o_text_print_text_height_full(FILE *fp, char *string, int size);
void o_text_print_text_string(FILE *fp, char *string, int unicode_count, gunichar *unicode_table);
void o_text_print(TOPLEVEL *toplevel, FILE *fp, OBJECT *o_current, int origin_x, int origin_y, int unicode_count, gunichar *unicode_table);
gdouble o_text_shortest_distance(TEXT *text, gint x, gint y);
diff --git a/libgeda/src/o_text_basic.c b/libgeda/src/o_text_basic.c
index 1aa54af..33dab39 100644
--- a/libgeda/src/o_text_basic.c
+++ b/libgeda/src/o_text_basic.c
@@ -1483,94 +1483,6 @@ void o_text_freeallfonts(TOPLEVEL *toplevel)
}
-/*! \todo Finish function documentation!!!
- * \brief
- * \par Function Description
- *
- */
-void o_text_print_text_width(FILE *fp, char *output_string)
-{
- int len, i, j;
- int starting_character = 0;
- int num_lines, line_number;
- int max_len = -1;
- char *single_line = NULL;
- char *max_length_line = NULL;
- int single_len;
-
- /* break up the string and find the longest string */
- num_lines = o_text_num_lines(output_string);
- single_line = g_strdup (output_string); /* larger than needed */
- len = strlen(output_string);
- for (line_number = 0; line_number < num_lines; line_number++)
- {
- j = 0;
- /* break up the string into lines */
- for (i = starting_character; i < len; i++)
- {
- if (output_string[i] != '\n' && output_string[i] != '\0')
- {
- single_line[j] = output_string[i];
- }
- else
- {
- starting_character = i + 1;
- break;
- }
- j++;
- }
- single_line[j] = '\0';
-
- single_len = strlen(single_line);
- if (single_len > max_len)
- {
- max_len = strlen(single_line);
- g_free(max_length_line);
- max_length_line = g_strdup (single_line);
- }
- }
-
-
- fprintf(fp, "(");
- len = strlen(max_length_line);
- for (i = 0 ; i < len; i++) {
- if (max_length_line[i] == '(' || max_length_line[i] == ')' || max_length_line[i] == '\\' ) {
- fprintf(fp, "\\");
- }
-
- fprintf(fp, "%c", max_length_line[i]);
- }
-
- /* convert width to mils */
- /* .95 is a fudge factor */
- fprintf(fp, ") stringwidth pop\n");
-
- g_free(single_line);
- g_free(max_length_line);
-}
-
-/*! \todo Finish function documentation!!!
- * \brief
- * \par Function Description
- *
- */
-void o_text_print_text_height(FILE *fp, int size)
-{
- fprintf(fp, "%f\n", (float) size);
-}
-
-/*! \todo Finish function documentation!!!
- * \brief
- * \par Function Description
- *
- */
-void o_text_print_text_height_full(FILE *fp, char *string, int size)
-{
- int num_lines = o_text_num_lines(string);
- fprintf(fp, "%f\n", (float) (size*num_lines +
- size * LINE_SPACING * (num_lines - 1)));
-}
-
/*! \brief write a text string to a postscript file
* \par Function Description
* This function writes the single \a string into the postscript file \a fp.
commit a0bd1fa71f376b01212f655bfdcd9da4fb046868
Author: Werner Hoch <werner.ho@xxxxxx>
Date: Sun Nov 2 14:42:56 2008 +0100
doxygen: documentation for libgeda o_text_basic.c
diff --git a/libgeda/src/o_text_basic.c b/libgeda/src/o_text_basic.c
index d95ebaf..1aa54af 100644
--- a/libgeda/src/o_text_basic.c
+++ b/libgeda/src/o_text_basic.c
@@ -57,6 +57,15 @@ GHashTable *font_char_to_file = NULL;
int tab_in_chars = 8;
+/*! \brief update the visible part of a string
+ * \par Function Description
+ * If a string is an attribute, then it is possible to hide
+ * the name or the value part of the attribute string.
+ * This functions updates the text->disp_string according
+ * to the object->show_name_value settings
+ *
+ * \param [in] o The OBJECT to update
+ */
static void update_disp_string(OBJECT *o)
{
char *name = NULL;
@@ -99,10 +108,16 @@ static void update_disp_string(OBJECT *o)
}
}
-/*! \todo Finish function documentation!!!
- * \brief
+/*! \brief calculate and return the boundaries of a text object
* \par Function Description
+ * This function calculates the object boudaries of a text \a object.
*
+ * \param [in] toplevel The TOPLEVEL object.
+ * \param [in] o_current a text object
+ * \param [out] left the left world coord
+ * \param [out] top the top world coord
+ * \param [out] right the right world coord
+ * \param [out] bottom the bottom world coord
*/
int world_get_text_bounds(TOPLEVEL *toplevel, OBJECT *o_current, int *left,
int *top, int *right, int *bottom)
@@ -111,10 +126,12 @@ int world_get_text_bounds(TOPLEVEL *toplevel, OBJECT *o_current, int *left,
left, top, right, bottom);
}
-/*! \todo Finish function documentation!!!
- * \brief
+/*! \brief create a new text head object
* \par Function Description
- *
+ * This function creates a <b>text_head</b> OBJECT. This OBJECT
+ * is just a special empty object. This object is never modified.
+ *
+ * \return new text head OBJECT
*/
OBJECT *o_text_new_head (void)
{
@@ -127,10 +144,10 @@ OBJECT *o_text_new_head (void)
return new_node;
}
-/*! \todo Finish function documentation!!!
- * \brief
+/*! \brief initialize the hash tables for the fonts
* \par Function Description
- *
+ * This function initializes the two global hash tables <b>font_loaded</b>
+ * and <b>font_char_to_file</b> that are used to store the fonts characters.
*/
void o_text_init(void)
{
@@ -156,10 +173,9 @@ void o_text_init(void)
}
-/*! \todo Finish function documentation!!!
- * \brief
- * \par Function Description
- *
+/*! \brief print informations about some characters
+ * \note
+ * This is a debugging function. Do not use it in regular code.
*/
void o_text_print_set(void)
{
@@ -182,10 +198,13 @@ void o_text_print_set(void)
}
}
-/*! \todo Finish function documentation!!!
- * \brief
+/*! \brief load a font character into an object
* \par Function Description
+ * This function loads a character form a font symbol file.
*
+ * \param [in] toplevel The TOPLEVEL object
+ * \param [in] needed_char unicode character to load
+ * return a character OBJECT
*/
OBJECT *o_text_load_font(TOPLEVEL *toplevel, gunichar needed_char)
{
@@ -283,10 +302,13 @@ OBJECT *o_text_load_font(TOPLEVEL *toplevel, gunichar needed_char)
return(o_font_set->font_prim_objs);
}
-/*! \todo Finish function documentation!!!
- * \brief
+/*! \brief count the lines of a text string
* \par Function Description
- *
+ * This function just counts the number of lines that are
+ * in the \a string.
+
+ * \param [in] string text string to count the lines
+ * \return the number of lines
*/
int o_text_num_lines(const char *string)
{
@@ -312,12 +334,16 @@ int o_text_num_lines(const char *string)
return (line_count);
}
-/*! \todo Finish function documentation!!!
- * \brief
+/*! \brief calculates the height of a text string
* \par Function Description
- *
+ * This function calculates the height of a \a string depending
+ * on it's text \a size. The number of lines and the spacing
+ * between the lines are taken into account.
+ *
+ * \param [in] string the text string
+ * \param [in] size the text size of the character
+ * \return the total height of the text string
*/
-/* You do not need to divide the size in half here. */
int o_text_height(const char *string, int size)
{
int line_count = 0;
@@ -336,13 +362,17 @@ int o_text_height(const char *string, int size)
return(26*size/2*(1+LINE_SPACING*(line_count-1)));
}
-/*! \todo Finish function documentation!!!
- * \brief
+/*! \brief calculate the width of a text
* \par Function Description
- *
+ * This function caluculates the width of a text \a string
+ * depending on the text \a size and the width of the individual
+ * characters that are in the text string.
+ *
+ * \param [in] toplevel The TOPLEVEL object
+ * \param [in] string The text string
+ * \param [in] size The text size
+ * \return the total width of the text.
*/
-/* You need to divide the size in half here. */
-/*! \todo FIXME consistancy. */
int o_text_width(TOPLEVEL *toplevel, char *string, int size)
{
int width=0, max_width=0;
@@ -418,10 +448,24 @@ int o_text_width(TOPLEVEL *toplevel, char *string, int size)
return max_width;
}
-/*! \todo Finish function documentation!!!
- * \brief
+/*! \brief create a complex text object from a string
* \par Function Description
+ * This function converts the \a string into a list of basic objects.
+ * All basic objects are appendend to the \a object_list.
+ * The basic objects are collected from the basic font definition
+ * of each character of they are created as lines for the overbar feature.
*
+ * \param [in] toplevel The TOPLEVEL object
+ * \param [in] object_list The list to append the basic objects
+ * \param [in] string The string to create the object list from
+ * \param [in] size The size of the text object
+ * \param [in] color The color of the text object
+ * \param [in] x The x coord of the text object
+ * \param [in] y The y coord of the text object
+ * \param [in] alignment The alignment of the text object
+ * \param [in] angle The angle of the text object (in 90 degree steps)
+ *
+ * \return the object list of the primary text objects
*/
OBJECT *o_text_create_string(TOPLEVEL *toplevel, OBJECT *object_list,
char *string, int size, int color, int x, int y,
@@ -901,8 +945,7 @@ OBJECT *o_text_create_string(TOPLEVEL *toplevel, OBJECT *object_list,
return(object_list);
}
-/*! \todo Finish function documentation!!!
- * \brief Creates a text OBJECT and the graphical objects representing it
+/*! \brief Creates a text OBJECT and the graphical objects representing it
* \par Function Description
* Create an OBJECT of type OBJ_TEXT.
* Also add the OBJECTs forming the graphical representation of the visible
@@ -990,10 +1033,12 @@ OBJECT *o_text_new(TOPLEVEL *toplevel,
return new_node;
}
-/*! \todo Finish function documentation!!!
- * \brief
+/*! \brief update the visual boundaries of the text 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_text_recalc(TOPLEVEL *toplevel, OBJECT *o_current)
{
@@ -1013,10 +1058,20 @@ void o_text_recalc(TOPLEVEL *toplevel, OBJECT *o_current)
o_current->w_bounds_valid = TRUE;
}
-/*! \todo Finish function documentation!!!
- * \brief
+/*! \brief read a text object from a char buffer
* \par Function Description
- *
+ * This function reads a text object from the textbuffer \a tb and
+ * the text starting with the line \a firstline.
+ * If the line object was read successfully, a new object is
+ * 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
+ * \param [in] fileformat_ver a integer value of the file format
+ * \return The object list
*/
OBJECT *o_text_read(TOPLEVEL *toplevel, OBJECT *object_list,
const char *first_line,
@@ -1152,10 +1207,14 @@ OBJECT *o_text_read(TOPLEVEL *toplevel, OBJECT *object_list,
return(object_list);
}
-/*! \todo Finish function documentation!!!
- * \brief
+/*! \brief read and set infos of a font object
* \par Function Description
- *
+ * This function reads the font definition buffer \a buf and sets
+ * the width of a character. This function also deals with the special,
+ * invisible character space and newline.
+ *
+ * \param [in] buf the font definition according to the geda file format
+ * \todo Investigate why the TAB character is not defined here.
*/
void o_text_set_info_font(char buf[])
{
@@ -1225,10 +1284,13 @@ void o_text_set_info_font(char buf[])
}
-/*! \todo Finish function documentation!!!
- * \brief
+/*! \brief Create a string representation of the text object
* \par Function Description
+ * This function takes a text \a object and return a string
+ * according to the file format definition.
*
+ * \param [in] object a text OBJECT
+ * \return the string representation of the text OBJECT
*/
char *o_text_save(OBJECT *object)
{
@@ -1263,10 +1325,13 @@ char *o_text_save(OBJECT *object)
return(buf);
}
-/*! \todo Finish function documentation!!!
- * \brief
+/*! \brief recreate the graphics of a text object
* \par Function Description
+ * This function updates the underlying primary of the text object
+ * \a o_current.
*
+ * \param toplevel The TOPLEVEL object
+ * \param o_current The text object to update
*/
void o_text_recreate(TOPLEVEL *toplevel, OBJECT *o_current)
{
@@ -1317,10 +1382,14 @@ void o_text_recreate(TOPLEVEL *toplevel, OBJECT *o_current)
g_free(value);
}
-/*! \todo Finish function documentation!!!
- * \brief
+/*! \brief move a text object
* \par Function Description
+ * This function changes the position of a text object \a o_current.
*
+ * \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] o_current The text OBJECT to be moved
*/
void o_text_translate_world(TOPLEVEL *toplevel,
int dx, int dy, OBJECT *o_current)
@@ -1334,10 +1403,13 @@ void o_text_translate_world(TOPLEVEL *toplevel,
o_text_recalc( toplevel, o_current );
}
-/*! \todo Finish function documentation!!!
- * \brief
+/*! \brief create a copy of a text object
* \par Function Description
+ * This function creates a copy of the text object \a o_current.
*
+ * \param [in] toplevel The TOPLEVEL object
+ * \param [in] o_current The object that is copied
+ * \return a new text object
*/
OBJECT *o_text_copy(TOPLEVEL *toplevel, OBJECT *o_current)
{
@@ -1362,10 +1434,13 @@ OBJECT *o_text_copy(TOPLEVEL *toplevel, OBJECT *o_current)
return new_obj;
}
-/*! \todo Finish function documentation!!!
- * \brief
+/*! \brief delete a font set
* \par Function Description
+ * This is a GHRFunc function that deletes a single font set.
*
+ * \param [in] key The hash key (the font charater)
+ * \param [in] value The value of the hash table (the font object)
+ * \param [in] user_data Data supplied by the user (the TOPLEVEL object)
*/
static gboolean delete_font_set (gpointer key, gpointer value,
gpointer user_data)
@@ -1388,10 +1463,10 @@ static gboolean delete_font_set (gpointer key, gpointer value,
return TRUE;
}
-/*! \todo Finish function documentation!!!
- * \brief
+/*! \brief free the font hash tables
* \par Function Description
- *
+ * This function destroys the two global font hash tables
+ * <b>font_loaded</b> and <b>font_char_to_file</b>
*/
void o_text_freeallfonts(TOPLEVEL *toplevel)
{
@@ -1496,10 +1571,16 @@ void o_text_print_text_height_full(FILE *fp, char *string, int size)
size * LINE_SPACING * (num_lines - 1)));
}
-/*! \todo Finish function documentation!!!
- * \brief
+/*! \brief write a text string to a postscript file
* \par Function Description
+ * This function writes the single \a string into the postscript file \a fp.
*
+ * \param [in] fp pointer to a FILE structure
+ * \param [in] string The string to print
+ * \param [in] unicode_count Number of items in the unicode table
+ * \param [in] unicode_table Table of unicode items
+ *
+ * \todo investigate whether the TAB character is handled correctly
*/
void o_text_print_text_string(FILE *fp, char *string, int unicode_count,
gunichar *unicode_table)
@@ -1550,10 +1631,17 @@ void o_text_print_text_string(FILE *fp, char *string, int unicode_count,
fprintf(fp,") ");
}
-/*! \todo Finish function documentation!!!
- * \brief
+/*! \brief print a text object into a postscript file
* \par Function Description
- *
+ * This function writes the postscript representation of the text object
+ * \a o_current into the the file \a fp.
+ * \param [in] toplevel The TOPLEVEL object
+ * \param [in] fp pointer to a FILE structure
+ * \param [in] o_current The OBJECT to print
+ * \param [in] origin_x x-coord of the postscript origin
+ * \param [in] origin_y y-coord of the postscript origin
+ * \param [in] unicode_count Number of items in the unicode table
+ * \param [in] unicode_table Table of unicode items
*/
void o_text_print(TOPLEVEL *toplevel, FILE *fp, OBJECT *o_current,
int origin_x, int origin_y,
@@ -1707,10 +1795,17 @@ void o_text_print(TOPLEVEL *toplevel, FILE *fp, OBJECT *o_current,
}
-/*! \todo Finish function documentation!!!
- * \brief
+/*! \brief rotate a text object around a centerpoint
* \par Function Description
- *
+ * This function rotates a text \a object around the point
+ * (\a world_centerx, \a world_centery).
+ *
+ * \param [in] toplevel The TOPLEVEL object
+ * \param [in] world_centerx x-coord of the rotation center
+ * \param [in] world_centery y-coord of the rotation center
+ * \param [in] angle The angle to rotate the text object
+ * \param [in] object The text object
+ * \note only steps of 90 degrees are allowed for the \a angle
*/
void o_text_rotate_world(TOPLEVEL *toplevel,
int world_centerx, int world_centery,
@@ -1738,10 +1833,15 @@ void o_text_rotate_world(TOPLEVEL *toplevel,
}
-/*! \todo Finish function documentation!!!
- * \brief
+/*! \brief mirror a text object horizontaly at a centerpoint
* \par Function Description
- *
+ * This function mirrors a text \a object horizontaly at the point
+ * (\a world_centerx, \a world_centery).
+ *
+ * \param [in] toplevel The TOPLEVEL object
+ * \param [in] world_centerx x-coord of the mirror position
+ * \param [in] world_centery y-coord of the mirror position
+ * \param [in] object The text object
*/
void o_text_mirror_world(TOPLEVEL *toplevel,
int world_centerx, int world_centery,
commit ad9d7ca705f1135a957d6e76244b164e94328ef1
Author: Werner Hoch <werner.ho@xxxxxx>
Date: Sun Nov 2 11:13:32 2008 +0100
remove unused defines from o_text_basic.c ...
and move some variables in front of all functions
diff --git a/libgeda/src/o_text_basic.c b/libgeda/src/o_text_basic.c
index 21d36a5..d95ebaf 100644
--- a/libgeda/src/o_text_basic.c
+++ b/libgeda/src/o_text_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_text_basic.c
+ * \brief functions for the text and fonts
+ */
+
#include <config.h>
#include <stdio.h>
@@ -38,8 +43,19 @@
/*! Default setting for text draw function. */
void (*text_draw_func)() = NULL;
-#define WINONLY 1
-#define BACKING 2
+/*! \note
+ * font storage and friends are staying global so that all can access
+ */
+
+/*! Hashtable storing font_character (string) as a key, and pointer to data */
+GHashTable *font_loaded = NULL;
+
+/*! Hashtable storing mapping between character and font definition file */
+GHashTable *font_char_to_file = NULL;
+
+/*! Size of a tab in characters */
+int tab_in_chars = 8;
+
static void update_disp_string(OBJECT *o)
{
@@ -83,19 +99,6 @@ static void update_disp_string(OBJECT *o)
}
}
-/*! \note
- * font storage and friends are staying global so that all can access
- */
-
-/*! Hashtable storing font_character (string) as a key, and pointer to data */
-GHashTable *font_loaded = NULL;
-
-/*! Hashtable storing mapping between character and font definition file */
-GHashTable *font_char_to_file = NULL;
-
-/*! Size of a tab in characters */
-int tab_in_chars = 8;
-
/*! \todo Finish function documentation!!!
* \brief
* \par Function Description
commit 2f30918c3ae433204df9149e6b494b32e2db8559
Author: Werner Hoch <werner.ho@xxxxxx>
Date: Tue Oct 28 22:20:36 2008 +0100
doxygen: libgeda: fixed more warnings from the doxygen log
added some documentation, too.
diff --git a/libgeda/src/g_rc.c b/libgeda/src/g_rc.c
index 1292d39..3aa358b 100644
--- a/libgeda/src/g_rc.c
+++ b/libgeda/src/g_rc.c
@@ -442,7 +442,8 @@ SCM g_rc_component_library(SCM path, SCM name)
* function, which can be used in the rc files to add a command to
* the component library.
*
- * \param [in] command Command to add.
+ * \param [in] listcmd command to get a list of symbols
+ * \param [in] getcmd command to get a symbol from the library
* \param [in] name Optional descriptive name for component source.
* \return SCM_BOOL_T on success, SCM_BOOL_F otherwise.
*/
diff --git a/libgeda/src/g_smob.c b/libgeda/src/g_smob.c
index 98d0083..5b15ede 100644
--- a/libgeda/src/g_smob.c
+++ b/libgeda/src/g_smob.c
@@ -545,7 +545,7 @@ SCM g_get_object_attributes(SCM object_smob)
* its attribute name is the given name, in a given object smob.
*
* \param [in] object_smob The object smob to get attributes from.
- * \param [in] attrib_name The name of the attribute you want the value.
+ * \param [in] scm_attrib_name The name of the attribute you want the value.
* \return A list of attribute values.
*/
SCM g_get_attrib_value_by_attrib_name(SCM object_smob, SCM scm_attrib_name)
diff --git a/libgeda/src/m_hatch.c b/libgeda/src/m_hatch.c
index f61e748..612ed62 100644
--- a/libgeda/src/m_hatch.c
+++ b/libgeda/src/m_hatch.c
@@ -66,7 +66,7 @@ static gint calculate_initial_sweep(gint pitch, gint min_y, gint max_y)
* and behavior are consistant with GCompareFunc.
*
* \param a [in] The first sweep event.
- * \param a [in] The second sweep event.
+ * \param b [in] The second sweep event.
* \return A negative value if the first is less than the second, zero if the
* first equals the second, and a positive value if the first is greater than
* the second.
@@ -85,7 +85,7 @@ static gint compare_events(gconstpointer a, gconstpointer b)
* and behavior are consistant with GCompareFunc.
*
* \param a [in] The first sweep status.
- * \param a [in] The second sweep status.
+ * \param b [in] The second sweep status.
* \return A negative value if the first is less than the second, zero if the
* first equals the second, and a positive value if the first is greater than
* the second.
diff --git a/libgeda/src/m_transform.c b/libgeda/src/m_transform.c
index 260781e..142e27e 100644
--- a/libgeda/src/m_transform.c
+++ b/libgeda/src/m_transform.c
@@ -27,8 +27,8 @@
*
* \param result [out] The resulting transformation. If either operand is
* NULL, the contents of the result remain unaltered.
- * \param transform0 [in] The first operand.
- * \param transform1 [in] The second operand.
+ * \param a [in] The second operand.
+ * \param b [in] The second operand.
*/
void m_transform_combine(TRANSFORM *result, TRANSFORM *a, TRANSFORM *b )
{
@@ -99,7 +99,7 @@ void m_transform_line(TRANSFORM *transform, LINE *line)
/** \brief Transforms multiple line segments
*
* \param transform [in] The transform function.
- * \param line [inout] The GArray of LINE to transform.
+ * \param lines [inout] The GArray of LINE to transform.
*/
void m_transform_lines(TRANSFORM *transform, GArray *lines)
{
@@ -139,7 +139,7 @@ void m_transform_point(TRANSFORM *transform, gint *x, gint *y)
/** \brief Transforms a polyline or polygon
*
* \param transform [in] The transform function.
- * \param line [inout] The GArray of sPOINT to transform.
+ * \param points [inout] The GArray of sPOINT to transform.
*/
void m_transform_points(TRANSFORM *transform, GArray *points)
{
diff --git a/libgeda/src/o_embed.c b/libgeda/src/o_embed.c
index a1cd97b..eaf0428 100644
--- a/libgeda/src/o_embed.c
+++ b/libgeda/src/o_embed.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_embed.c
+ * \brief functions to embed and unembed symbols
+ */
+
#include <config.h>
#include <stdio.h>
@@ -30,10 +35,14 @@
#endif
-/*! \todo Finish function documentation!!!
- * \brief
+/*! \brief embed an object into a schematic
* \par Function Description
- *
+ * This functions embeds an object \a o_current into a
+ * libgeda. Currently complex objects are just marked to
+ * be embedded later. Picture objects are embedded immediatly.
+ *
+ * \param toplevel The TOPLEVEL object
+ * \param o_current The OBJECT to embed
*/
void o_embed(TOPLEVEL *toplevel, OBJECT *o_current)
{
@@ -63,10 +72,14 @@ void o_embed(TOPLEVEL *toplevel, OBJECT *o_current)
}
}
-/*! \todo Finish function documentation!!!
- * \brief
+/*! \brief unembed an object from a schematic
* \par Function Description
- *
+ * This functions unembeds an object \a o_current from a
+ * libgeda structure. Complex objects are just marked to
+ * be not embedded. Picture objects are unembeded immediatly.
+ *
+ * \param toplevel The TOPLEVEL object
+ * \param o_current The OBJECT to unembed
*/
void o_unembed(TOPLEVEL *toplevel, OBJECT *o_current)
{
diff --git a/libgeda/src/o_path_basic.c b/libgeda/src/o_path_basic.c
index 730f459..41c8d51 100644
--- a/libgeda/src/o_path_basic.c
+++ b/libgeda/src/o_path_basic.c
@@ -62,7 +62,7 @@ typedef void (*FILL_FUNC) (TOPLEVEL *toplevel, FILE *fp, PATH *path,
*
* Both the path type and the filling type are set to default
* values : solid path type with a width of 0, and no filling.
- * It can be changed after with the #o_set_path_options() and
+ * It can be changed after with the #o_set_line_options() and
* #o_set_fill_options().
*
* The object is added to the end of the list described by the
@@ -70,7 +70,8 @@ typedef void (*FILL_FUNC) (TOPLEVEL *toplevel, FILE *fp, PATH *path,
*
* \param [in] toplevel The TOPLEVEL object.
* \param [in] type Must be OBJ_PATH.
- * \param [in] color Circle path color.
+ * \param [in] color The path color.
+ * \param [in] path_string The string representation of the path
* \return A pointer to the new end of the object list.
*/
OBJECT *o_path_new (TOPLEVEL *toplevel,
@@ -524,7 +525,7 @@ void o_path_recalc (TOPLEVEL *toplevel, OBJECT *o_current)
* the convex hull of the curve control and end-points.
*
* \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 path coordinate in WORLD units.
* \param [out] top Top path coordinate in WORLD units.
* \param [out] right Right path coordinate in WORLD units.
@@ -590,10 +591,7 @@ void world_get_path_bounds (TOPLEVEL *toplevel, OBJECT *object,
*
* \param [in] toplevel The TOPLEVEL object.
* \param [in] fp FILE pointer to Postscript document.
- * \param [in] x Upper x coordinate of PATH.
- * \param [in] y Upper y coordinate of PATH.
- * \param [in] width Width of PATH.
- * \param [in] height Height of PATH.
+ * \param [in] path The PATH object ot print
* \param [in] line_width PATH Line width.
* \param [in] length Dashed line length.
* \param [in] space Amount of space between dashes.
diff --git a/libgeda/src/o_selection.c b/libgeda/src/o_selection.c
index 1ba3bf6..616353f 100644
--- a/libgeda/src/o_selection.c
+++ b/libgeda/src/o_selection.c
@@ -99,7 +99,7 @@ void o_selection_print_all(const SELECTION *selection)
/*! \brief Selects the given object.
* \par Sets the select flag, saves the color, and then selects the
* given object
- * \param [in] o_selected Object to select.
+ * \param [in] object Object to select.
* \param [in] color color of the selected object.
*/
void o_selection_select(OBJECT *object, int color)
diff --git a/libgeda/src/s_page.c b/libgeda/src/s_page.c
index 52cd7ad..39923ee 100644
--- a/libgeda/src/s_page.c
+++ b/libgeda/src/s_page.c
@@ -42,8 +42,7 @@
static gint global_pid = 0;
-/*! \todo Finish function documentation!!!
- * \brief
+/*! \brief create a new page object
* \par Function Description
* Creates a new page and add it to <B>toplevel</B>'s list of pages.
*
@@ -118,8 +117,7 @@ PAGE *s_page_new (TOPLEVEL *toplevel, const gchar *filename)
return page;
}
-/*! \todo Finish function documentation!!!
- * \brief
+/*! \brief delete a page and it's contents
* \par Function Description
* Deletes a single page <B>page</B> from <B>toplevel</B>'s list of pages.
*
@@ -219,11 +217,12 @@ void s_page_delete (TOPLEVEL *toplevel, PAGE *page)
}
-/*! \todo Finish function documentation!!!
- * \brief Deletes the list of pages of <B>toplevel</B>.
+/*! \brief Deletes the list of pages of <B>toplevel</B>.
* \par Function Description
* Deletes the list of pages of <B>toplevel</B>.
* This function should only be called when you are finishing up.
+ *
+ * \param toplevel The TOPLEVEL object.
*/
void s_page_delete_list(TOPLEVEL *toplevel)
{
@@ -245,11 +244,12 @@ void s_page_delete_list(TOPLEVEL *toplevel)
toplevel->page_current = NULL;
}
-/*! \todo Finish function documentation!!!
- * \brief Changes the current page in <B>toplevel</B> to be <B>p_new</B>.
+/*! \brief changes the current page in toplevel
* \par Function Description
- * Changes the current page in <B>toplevel</B> to be <B>p_new</B>.
+ * Changes the current page in \a toplevel to the page \a p_new.
*
+ * \param toplevel The TOPLEVEL object
+ * \param p_new The PAGE to go to
*/
void s_page_goto (TOPLEVEL *toplevel, PAGE *p_new)
{
@@ -266,11 +266,13 @@ void s_page_goto (TOPLEVEL *toplevel, PAGE *p_new)
}
-/*! \todo Finish function documentation!!!
- * \brief Search for pages by filename.
+/*! \brief Search for pages by filename.
* \par Function Description
- * Searches in <B>toplevel</B>'s list of pages for a page with a filename
- * equal to <B>filename</B>.
+ * Searches in \a toplevel's list of pages for a page with a filename
+ * equal to \a filename.
+ *
+ * \param toplevel The TOPLEVEL object
+ * \param filename The filename string to search for
*
* \return PAGE pointer to a matching page, NULL otherwise.
*/
@@ -296,7 +298,7 @@ PAGE *s_page_search (TOPLEVEL *toplevel, const gchar *filename)
* the list of pages starting at \a page_list, or NULL if there is no
* such page.
*
- * \param [in] page_list The list of page to search the page in.
+ * \param [in] list The list of page to search the page in.
* \param [in] pid The ID of the page to find.
* \returns A pointer on the page found or NULL if not found.
*/
@@ -338,8 +340,7 @@ void s_page_print_all (TOPLEVEL *toplevel)
}
}
-/*! \todo Finish function documentation!!!
- * \brief Saves all the pages of a TOPLEVEL object.
+/*! \brief Saves all the pages of a TOPLEVEL object.
* \par Function Description
* Saves all the pages in the <B>toplevel</B> parameter.
*
@@ -388,8 +389,7 @@ gint s_page_save_all (TOPLEVEL *toplevel)
return status;
}
-/*! \todo Finish function documentation!!!
- * \brief Check if CHANGED flag is set for any page in list.
+/*! \brief Check if CHANGED flag is set for any page in list.
* \par Function Description
* This function checks the CHANGED flag for all pages in the <B>list</B>
* object.
@@ -417,9 +417,9 @@ gboolean s_page_check_changed (GedaPageList *list)
/*! \brief Reset the CHANGED flag of all pages.
* \par Function Description
- * This function resets the CHANGED flag of each page following <B>head</B>.
+ * This function resets the CHANGED flag of each page following \a head.
*
- * \param [in,out] head PAGE list to set CHANGED flags in.
+ * \param [in,out] list PAGE list to set CHANGED flags in.
*/
void s_page_clear_changed (GedaPageList *list)
{
_______________________________________________
geda-cvs mailing list
geda-cvs@xxxxxxxxxxxxxx
http://www.seul.org/cgi-bin/mailman/listinfo/geda-cvs