[Author Prev][Author Next][Thread Prev][Thread Next][Author Index][Thread Index]
gEDA-cvs: CVS update: f_export.c
User: sdb
Date: 07/04/16 07:57:51
Modified: . f_export.c g_rc.c g_register.c gattrib.c
gtkitementry_2_2.c gtksheet_2_2.c s_attrib.c
s_object.c s_sheet_data.c s_string_list.c s_table.c
Log:
Added DOxygen comment pragma to many .c files.
Revision Changes Path
1.2 +6 -0 eda/geda/gaf/gattrib/src/f_export.c
(In the diff below, changes in quantity of whitespace are not shown.)
Index: f_export.c
===================================================================
RCS file: /home/cvspsrv/cvsroot/eda/geda/gaf/gattrib/src/f_export.c,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- f_export.c 26 Jul 2006 22:57:19 -0000 1.1
+++ f_export.c 16 Apr 2007 11:57:50 -0000 1.2
@@ -43,6 +43,12 @@
/* =================== Public Functions ====================== */
+/* ------------------------------------------------------------- */
+/* \brief This function is invoked when the user selects file ->
+ * export from the pull-down menu. It writes out a CSV file
+ * of the design for external processing.
+ *
+ * ------------------------------------------------------------- */
void f_export_components(gchar *filename)
{
gint cur_page;
1.5 +1 -2 eda/geda/gaf/gattrib/src/g_rc.c
(In the diff below, changes in quantity of whitespace are not shown.)
Index: g_rc.c
===================================================================
RCS file: /home/cvspsrv/cvsroot/eda/geda/gaf/gattrib/src/g_rc.c,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -b -r1.4 -r1.5
--- g_rc.c 7 Sep 2006 02:41:28 -0000 1.4
+++ g_rc.c 16 Apr 2007 11:57:50 -0000 1.5
@@ -75,8 +75,7 @@
"but you have a version [%s] gattribrc file:\n[%s]\n",
SCM_STRING_CHARS (version), rc_filename);
fprintf(stderr,
- "While gattrib is in ALPHA, "
- "please be sure that you have the latest rc file.\n");
+ "Please run a version of gattrib compatible with your gEDA installation.\n");
return SCM_BOOL_F;
}
1.6 +3 -2 eda/geda/gaf/gattrib/src/g_register.c
(In the diff below, changes in quantity of whitespace are not shown.)
Index: g_register.c
===================================================================
RCS file: /home/cvspsrv/cvsroot/eda/geda/gaf/gattrib/src/g_register.c,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -b -r1.5 -r1.6
--- g_register.c 19 Oct 2006 03:11:17 -0000 1.5
+++ g_register.c 16 Apr 2007 11:57:50 -0000 1.6
@@ -47,10 +47,11 @@
/* GtkWidget *w_main; */
-/* ---------------------------------------------------------------------- *
- * g_register_funcs -- this registers the Scheme functions required to use
+/* ---------------------------------------------------------------------- */
+/*! \brief This function registers the Scheme functions required to use
* gattrib. They are mostly unnecessary, except for reading in the gattribrc
* file at the beginning of the prog which gives the library search paths.
+ *
* ---------------------------------------------------------------------- */
void g_register_funcs(void)
{
1.22 +27 -13 eda/geda/gaf/gattrib/src/gattrib.c
(In the diff below, changes in quantity of whitespace are not shown.)
Index: gattrib.c
===================================================================
RCS file: /home/cvspsrv/cvsroot/eda/geda/gaf/gattrib/src/gattrib.c,v
retrieving revision 1.21
retrieving revision 1.22
diff -u -b -r1.21 -r1.22
--- gattrib.c 19 Oct 2006 05:06:09 -0000 1.21
+++ gattrib.c 16 Apr 2007 11:57:50 -0000 1.22
@@ -1,6 +1,6 @@
/* gEDA - GPL Electronic Design Automation
* gattrib -- gEDA component and net attribute manipulation using spreadsheet.
- * Copyright (C) 2003 Stuart D. Brorson.
+ * Copyright (C) 2003-2007 Stuart D. Brorson.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@@ -36,8 +36,8 @@
#include <unistd.h>
#endif
-/*------------------------------------------------------------------
- * Includes originally from testgtksheet -- stuff needed to deal with
+/*------------------------------------------------------------------*/
+/* Includes originally from testgtksheet -- stuff needed to deal with
* spreadsheet widget.
*------------------------------------------------------------------*/
#include <stdio.h>
@@ -53,8 +53,8 @@
#include <string.h>
#endif
-/*------------------------------------------------------------------
- * Gattrib specific includes -- stuff dealing with gattrib data structs.
+/*------------------------------------------------------------------*/
+/* Gattrib specific includes -- stuff dealing with gattrib data structs.
*------------------------------------------------------------------*/
#include <libgeda/libgeda.h> /* geda library fcns */
#include "../include/struct.h" /* typdef and struct declarations */
@@ -65,9 +65,14 @@
#include <dmalloc.h>
#endif
-/*------------------------------------------------------------------
- * gattrib_really_quit callback -- called when user selects "quit"
- * from menubar. Checks for unsaved changes.
+/*------------------------------------------------------------------*/
+/*! \brief gattrib_really_quit callback -- called when user
+ * selects "quit" from menubar. Checks for unsaved
+ * changes.
+ * \par
+ *
+ * \return Returns 0 to shell (successful quit).
+ *
*------------------------------------------------------------------*/
void gattrib_really_quit(void)
{
@@ -80,8 +85,11 @@
}
-/*------------------------------------------------------------------
- * gattrib_quit -- wrap up and quit fcn.
+/*------------------------------------------------------------------*/
+/*! \brief gattrib_quit -- wrap up and quit fcn.
+ *
+ * \par
+ *
*------------------------------------------------------------------*/
gint gattrib_quit(gint return_code)
{
@@ -99,8 +107,11 @@
}
-/*------------------------------------------------------------------
- * gattrib_main -- main gattrib fcn.
+/*------------------------------------------------------------------*/
+/*! \brief gattrib_main -- main gattrib fcn.
+ *
+ * \par
+ *
*------------------------------------------------------------------*/
void gattrib_main(void *closure, int argc, char *argv[])
{
@@ -362,10 +373,13 @@
}
/*------------------------------------------------------------------
- * main -- entry point to gattrib. This is just a wrapper which
+/*! \brief main -- entry point to gattrib. This is just a wrapper which
* invokes the guile stuff, and points to the real main prog,
* gattrib_main. Note that I still need some vestigal
* guile stuff in order to read the rc files.
+ *
+ * \par
+ *
*------------------------------------------------------------------*/
int main(int argc, char *argv[])
{
1.7 +68 -4 eda/geda/gaf/gattrib/src/gtkitementry_2_2.c
(In the diff below, changes in quantity of whitespace are not shown.)
Index: gtkitementry_2_2.c
===================================================================
RCS file: /home/cvspsrv/cvsroot/eda/geda/gaf/gattrib/src/gtkitementry_2_2.c,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -b -r1.6 -r1.7
--- gtkitementry_2_2.c 27 Sep 2005 22:45:27 -0000 1.6
+++ gtkitementry_2_2.c 16 Apr 2007 11:57:50 -0000 1.7
@@ -75,6 +75,7 @@
*/
static void gtk_item_entry_class_init (GtkItemEntryClass *klass);
static void gtk_item_entry_init (GtkItemEntry *entry);
+
static void gtk_item_entry_editable_init (GtkEditableClass *iface);
/* GtkWidget methods
@@ -196,7 +197,12 @@
static GtkEntryClass *parent_class = NULL;
/* =============================== Fcns ========================== */
-
+/* ----------------------------------------------------------------- */
+/*! \brief This function returns the type of the gtk_item entry widget.
+ * It may be removed at some point since the GtkItemEntry isn't used
+ * in gattrib.
+ *
+ * ----------------------------------------------------------------- */
GtkType
gtk_item_entry_get_type (void)
{
@@ -235,6 +241,12 @@
return item_entry_type;
}
+/* ----------------------------------------------------------------- */
+/*! \brief This function initializes the GtkItemEntry. It may be
+ * removed at some future time since gattrib doesn't use a GtkItemEntry
+ * widget.
+ *
+ * ----------------------------------------------------------------- */
static void
gtk_item_entry_class_init (GtkItemEntryClass *class)
{
@@ -275,6 +287,10 @@
G_PARAM_READABLE));
}
+/* ----------------------------------------------------------------- */
+/*! \brief ?????
+ *
+ * ----------------------------------------------------------------- */
static void
gtk_item_entry_editable_init (GtkEditableClass *iface)
{
@@ -286,6 +302,12 @@
iface->get_position = gtk_entry_get_position;
}
+
+/* ----------------------------------------------------------------- */
+/*! \brief This function initializes the GtkItem, which is the individual
+ * box in the spreadsheet into which you type strings (I think).
+ *
+ * ----------------------------------------------------------------- */
static void
gtk_item_entry_init (GtkItemEntry *entry)
{
@@ -323,6 +345,14 @@
}
+/* ----------------------------------------------------------------- */
+/*! \brief This function realizes the GtkItem -- the individual
+ * box in the spreadsheet into which you type strings (I think).
+ * To realize a Gtk widget means that you create the resources
+ * associated with a widget. It is implicitly done when you show
+ * a widget.
+ *
+ * ----------------------------------------------------------------- */
static void
gtk_entry_realize (GtkWidget *widget)
{
@@ -379,6 +409,11 @@
gtk_entry_adjust_scroll (entry);
}
+/* ----------------------------------------------------------------- */
+/*! \brief Places the GtkEntry widget borders into *xborder and
+ * *yborder.
+ *
+ * ----------------------------------------------------------------- */
static void
get_borders (GtkEntry *entry,
gint *xborder,
@@ -412,6 +447,10 @@
}
+/* ----------------------------------------------------------------- */
+/*! \brief Tries to set the size of the GtkEntry widget.
+ *
+ * ----------------------------------------------------------------- */
static void
gtk_entry_size_request (GtkWidget *widget,
GtkRequisition *requisition)
@@ -447,6 +486,12 @@
pango_font_metrics_unref (metrics);
}
+/* ----------------------------------------------------------------- */
+/*! \brief Tries to return the size of the text area of a GtkEntry.
+ * Returns the x, y positions fo the border, and also returns the
+ * widget width and height.
+ *
+ * ----------------------------------------------------------------- */
static void
get_text_area_size (GtkEntry *entry,
gint *x,
@@ -475,6 +520,12 @@
*height = requisition.height - yborder * 2;
}
+/* ----------------------------------------------------------------- */
+/*! \brief Tries to return the size of the window area of a GtkEntry.
+ * Returns the x, y positions fo the border, and also returns the
+ * widget width and height.
+ *
+ * ----------------------------------------------------------------- */
static void
get_widget_window_size (GtkEntry *entry,
gint *x,
@@ -510,6 +561,10 @@
}
}
+/* ----------------------------------------------------------------- */
+/*! \brief Tries to set the size of a GtkEntry
+ *
+ * ----------------------------------------------------------------- */
static void
gtk_entry_size_allocate (GtkWidget *widget,
GtkAllocation *allocation)
@@ -544,11 +599,19 @@
}
}
+/* ----------------------------------------------------------------- */
+/*! \brief ?????
+ *
+ * ----------------------------------------------------------------- */
static void
gtk_entry_draw_frame (GtkWidget *widget)
{
}
+/* ----------------------------------------------------------------- */
+/*! \brief ???
+ *
+ * ----------------------------------------------------------------- */
static gint
gtk_entry_expose (GtkWidget *widget,
GdkEventExpose *event)
@@ -2209,19 +2272,17 @@
gtk_item_entry_new (void)
{
-#if 0
- /* old stuff removed by SDB */
GtkWidget *widget;
widget = GTK_WIDGET (gtk_type_new (GTK_TYPE_ITEM_ENTRY));
return widget;
-#endif
/* Copied from GtkEntry by SDB */
return g_object_new (GTK_TYPE_ITEM_ENTRY, NULL);
}
+
GtkWidget*
gtk_item_entry_new_with_max_length (gint max)
{
@@ -2233,6 +2294,7 @@
return GTK_WIDGET (entry);
}
+
void
gtk_item_entry_set_text (GtkItemEntry *entry,
const gchar *text,
@@ -2266,6 +2328,8 @@
gtk_editable_insert_text (GTK_EDITABLE (entry), text, strlen (text), &tmp_pos);
}
+
+
/**
* gtk_entry_get_layout_offsets:
* @entry: a #GtkEntry
1.12 +31 -13 eda/geda/gaf/gattrib/src/gtksheet_2_2.c
(In the diff below, changes in quantity of whitespace are not shown.)
Index: gtksheet_2_2.c
===================================================================
RCS file: /home/cvspsrv/cvsroot/eda/geda/gaf/gattrib/src/gtksheet_2_2.c,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -b -r1.11 -r1.12
--- gtksheet_2_2.c 31 Jul 2006 19:09:24 -0000 1.11
+++ gtksheet_2_2.c 16 Apr 2007 11:57:50 -0000 1.12
@@ -158,8 +158,10 @@
}
}
-/* gives the top pixel of the given row in context of
- * the sheet's voffset */
+/*! \brief gives the top pixel of the given row in context of
+ * the sheet's voffset
+ *
+ */
static inline gint
ROW_TOP_YPIXEL(GtkSheet *sheet, gint nrow)
{
@@ -167,8 +169,10 @@
}
-/* returns the row index from a y pixel location in the
- * context of the sheet's voffset */
+/*! \brief returns the row index from a y pixel location in the
+ * context of the sheet's voffset
+ *
+ */
static inline gint
ROW_FROM_YPIXEL(GtkSheet *sheet, gint y)
{
@@ -190,16 +194,20 @@
}
-/* gives the left pixel of the given column in context of
- * the sheet's hoffset */
+/*! \brief gives the left pixel of the given column in context of
+ * the sheet's hoffset
+ *
+ */
static inline gint
COLUMN_LEFT_XPIXEL(GtkSheet *sheet, gint ncol)
{
return (sheet->hoffset + sheet->column[ncol].left_xpixel);
}
-/* returns the column index from a x pixel location in the
- * context of the sheet's hoffset */
+/*! \brief returns the column index from a x pixel location in the
+ * context of the sheet's hoffset
+ *
+ */
static inline gint
COLUMN_FROM_XPIXEL (GtkSheet * sheet,
gint x)
@@ -221,7 +229,9 @@
return sheet->maxcol;
}
-/* returns the total height of the sheet */
+/*! \brief returns the total height of the sheet
+ *
+ */
static inline gint SHEET_HEIGHT(GtkSheet *sheet)
{
gint i,cx;
@@ -235,7 +245,9 @@
}
-/* returns the total width of the sheet */
+/*! \brief returns the total width of the sheet
+ *
+ */
static inline gint SHEET_WIDTH(GtkSheet *sheet)
{
gint i,cx;
@@ -589,7 +601,9 @@
/* Signals */
-/* Imported from gtkextra.c by SDB 7.22.2004 */
+/* \brief Imported from gtkextra.c by SDB 7.22.2004
+ *
+ */
void
_gtkextra_signal_emit(GtkObject *object, guint signal_id, ...)
{
@@ -4165,11 +4179,13 @@
gtk_entry_set_editable(GTK_ENTRY(sheet_entry), TRUE);
}
+
if(!GTK_IS_ITEM_ENTRY(sheet_entry))
gtk_entry_set_text(GTK_ENTRY(sheet_entry), text);
else
gtk_item_entry_set_text(GTK_ITEM_ENTRY(sheet_entry), text, justification);
+
gtk_sheet_entry_set_max_size(sheet);
gtk_sheet_size_allocate_entry(sheet);
@@ -5570,6 +5586,7 @@
}
+/* Removed by SDB while cleaning up key press behavior */
#if 0
static gint
gtk_sheet_entry_key_press(GtkWidget *widget,
@@ -6274,6 +6291,7 @@
if(!GTK_IS_ITEM_ENTRY(sheet->sheet_entry) || gtk_sheet_clip_text(sheet)) return;
+
justification = GTK_ITEM_ENTRY(sheet->sheet_entry)->justification;
switch(justification){
1.5 +11 -6 eda/geda/gaf/gattrib/src/s_attrib.c
(In the diff below, changes in quantity of whitespace are not shown.)
Index: s_attrib.c
===================================================================
RCS file: /home/cvspsrv/cvsroot/eda/geda/gaf/gattrib/src/s_attrib.c,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -b -r1.4 -r1.5
--- s_attrib.c 5 Feb 2005 16:03:53 -0000 1.4
+++ s_attrib.c 16 Apr 2007 11:57:50 -0000 1.5
@@ -38,9 +38,11 @@
#endif
-/*------------------------------------------------------------------
- * This fcn is passed a STRING_LIST of name=value pairs, and a
- * name. It returns 1 (TRUE) if the name is in the STRING_LIST, otherwise
+/*------------------------------------------------------------------*/
+/*! \brief This fcn is passed a STRING_LIST of name=value pairs, and a
+ * name.
+ *
+ * \return It returns 1 (TRUE) if the name is in the STRING_LIST, otherwise
* it returns 0 (FALSE).
*------------------------------------------------------------------*/
int s_attrib_name_in_list(STRING_LIST *name_value_list, char *name)
@@ -60,9 +62,12 @@
}
-/*------------------------------------------------------------------
- * This fcn takes an object, finds its refdes and returns it.
- * If the component is slotted, it returns a refdes of the form
+/*------------------------------------------------------------------*/
+/*! \brief This fcn takes an object, finds its refdes and returns it.
+ *
+ * \return For normal components, it returns a (pointer to a)
+ * string containing the
+ * refdes If the component is slotted, it returns a refdes of the form
* refdes.slot. If no refdes is found, it returns NULL.
*------------------------------------------------------------------*/
char *s_attrib_get_refdes(OBJECT *object)
1.10 +25 -17 eda/geda/gaf/gattrib/src/s_object.c
(In the diff below, changes in quantity of whitespace are not shown.)
Index: s_object.c
===================================================================
RCS file: /home/cvspsrv/cvsroot/eda/geda/gaf/gattrib/src/s_object.c,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -b -r1.9 -r1.10
--- s_object.c 23 Dec 2006 16:27:34 -0000 1.9
+++ s_object.c 16 Apr 2007 11:57:50 -0000 1.10
@@ -51,8 +51,8 @@
/* =================== Public Functions ====================== */
-/*------------------------------------------------------------------
- * This fcn adds a new attrib to o_current, when o_current is a
+/*------------------------------------------------------------------*/
+/*! \brief This fcn adds a new attrib to o_current, when o_current is a
* component. It does it in the following
* way:
* 1. It creates an object -- "attrib_graphic" -- and fills it in.
@@ -60,6 +60,7 @@
* calls o_text_add to add pos info and name=value string
* to attrib_graphic.
* 3. It calls o_attrib_add to wrap attrib_graphic with (ATTRIB )
+ *
*------------------------------------------------------------------ */
void s_object_add_comp_attrib_to_object(OBJECT *o_current,
char *new_attrib_name,
@@ -83,8 +84,9 @@
}
-/*------------------------------------------------------------------*
- * This needs to be filled in.
+/*------------------------------------------------------------------*/
+/*! /brief This needs to be filled in.
+ *
*------------------------------------------------------------------*/
void s_object_add_net_attrib_to_object(OBJECT *o_current, char *new_attrib_name,
char *new_attrib_value)
@@ -93,8 +95,8 @@
}
-/*------------------------------------------------------------------
- * This fcn adds a new attrib to o_current, when o_current is a
+/*------------------------------------------------------------------*/
+/*! \brief This fcn adds a new attrib to o_current, when o_current is a
* pin. It does it in the following
* way:
* 1. It creates an object -- "attrib_graphic" -- and fills it in.
@@ -104,6 +106,7 @@
* 3. It calls o_attrib_add to wrap attrib_graphic with (ATTRIB )
* Question: Do I really need separate fcns for comps, nets, and
* pins???
+ *
*------------------------------------------------------------------ */
void s_object_add_pin_attrib_to_object(OBJECT *o_current, char *new_attrib_name,
char *new_attrib_value)
@@ -127,9 +130,10 @@
-/*------------------------------------------------------------------
- * This fcn finds the instance of attrib_name on o_current, and
+/*------------------------------------------------------------------*/
+/*! \brief This fcn finds the instance of attrib_name on o_current, and
* replaces it's value wiht new_attrib_value.
+ *
*------------------------------------------------------------------*/
void s_object_replace_attrib_in_object(OBJECT *o_current,
char *new_attrib_name,
@@ -183,8 +187,9 @@
}
-/*------------------------------------------------------------------
- * This fcn removes attrib from o_current.
+/*------------------------------------------------------------------*/
+/*! \brief This fcn removes attrib from o_current.
+ *
*------------------------------------------------------------------*/
void s_object_remove_attrib_in_object(OBJECT *o_current, char *new_attrib_name)
{
@@ -233,10 +238,11 @@
-/*------------------------------------------------------------------
- * This fcn attaches the name=value pair to the OBJECT "object" It
+/*------------------------------------------------------------------*/
+/*! \brief This fcn attaches the name=value pair to the OBJECT "object" It
* was stolen from gschem/src/o_attrib.c:o_attrib_add_attrib and
* hacked for gattrib. Does it need to return OBJECT?
+ *
*------------------------------------------------------------------*/
OBJECT *s_object_attrib_add_attrib_in_object(TOPLEVEL * pr_current, char *text_string,
int visibility, int show_name_value,
@@ -328,8 +334,8 @@
-/*------------------------------------------------------------------
- * This fcn deletes the text object pointed to by text_object. It
+/*------------------------------------------------------------------*/
+/*! \brief This fcn deletes the text object pointed to by text_object. It
* was shamelessly stolen from gschem/src/o_delete.c and hacked
* for gattrib by SDB.
*------------------------------------------------------------------*/
@@ -347,9 +353,11 @@
}
-/*------------------------------------------------------------------
- * This verifies that the object has a non-null symbol file.
- * It returns 0 = valid symbol file, 1 = no symbol file found.
+/*------------------------------------------------------------------*/
+/*! \brief This verifies that the object has a non-null symbol file.
+ *
+ * \returns It returns 0 = valid symbol file, 1 = no symbol file found.
+ *
*------------------------------------------------------------------*/
int s_object_has_sym_file(OBJECT *object)
{
1.13 +36 -18 eda/geda/gaf/gattrib/src/s_sheet_data.c
(In the diff below, changes in quantity of whitespace are not shown.)
Index: s_sheet_data.c
===================================================================
RCS file: /home/cvspsrv/cvsroot/eda/geda/gaf/gattrib/src/s_sheet_data.c,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -b -r1.12 -r1.13
--- s_sheet_data.c 3 Apr 2007 11:24:31 -0000 1.12
+++ s_sheet_data.c 16 Apr 2007 11:57:51 -0000 1.13
@@ -46,9 +46,11 @@
#endif
-/*------------------------------------------------------------------
- * This fcn is the sheet_data creator. It returns a pointer to
+/*------------------------------------------------------------------*/
+/*! \brief This fcn is the sheet_data creator.
+ * It returns a pointer to
* an initialized SHEET_DATA struct.
+ *
*------------------------------------------------------------------*/
SHEET_DATA *s_sheet_data_new()
{
@@ -89,11 +91,14 @@
-/*------------------------------------------------------------------
- * This fcn adds to the master list of components refdeses by running
+/*------------------------------------------------------------------*/
+/*! \brief This fcn adds to the master list of
+ * components refdeses by running
* through the components and recording the comp refdeses
* it discovers. Then it sorts them into alphabetical order.
- * Data struct being searched is: OBJECT->attribs(->next. . .)->object->text->string
+ * Data struct being searched is:
+ * OBJECT->attribs(->next. . .)->object->text->string
+ *
*------------------------------------------------------------------*/
void s_sheet_data_add_master_comp_list_items(OBJECT *start_obj) {
char *temp_uref;
@@ -147,12 +152,14 @@
}
-/*------------------------------------------------------------------
- * This fcn adds to the master list of comp attribs by running
+/*------------------------------------------------------------------*/
+/*! \brief This fcn adds to the master list of comp attribs by running
* through each component on the page and recording all attribs
* it discovers. Then it sorts them into an order used for the
* horiz listing of the attribs on the spreadsheet.
- * Data struct being searched is: sheet_head->component_list_head->attrib->name;
+ * Data struct being searched is:
+ * sheet_head->component_list_head->attrib->name;
+ *
*------------------------------------------------------------------*/
void s_sheet_data_add_master_comp_attrib_list_items(OBJECT *start_obj) {
char *attrib_text;
@@ -223,26 +230,33 @@
-/*------------------------------------------------------------------
- * This fcn builds the master list of net names by running
+/*------------------------------------------------------------------*/
+/*! \brief This fcn builds the master list of net names by running
* through the individual cells and recording the net refdeses
* it discovers.
+ * It's currently empty, waiting for implementation of net
+ * attributes.
+ *
*------------------------------------------------------------------*/
void s_sheet_data_add_master_net_list_items(OBJECT *start_obj) {
return;
}
-/*------------------------------------------------------------------
- * This fcn builds the master list of net attribs.
+/*------------------------------------------------------------------*/
+/*! \brief This fcn builds the master list of net attribs.
+ * It's currently empty, waiting for implementation of net
+ * attributes.
+ *
*------------------------------------------------------------------*/
void s_sheet_data_add_master_net_attrib_list_items(OBJECT *start_obj) {
return;
}
-/*------------------------------------------------------------------
- * This fcn builds the master list of pin names. It writes the
+/*------------------------------------------------------------------*/
+/*! \brief This fcn builds the master
+ * list of pin names. It writes the
* label refdes:pinnumber into the global master pin list.
* Algorithm:
* 1. Loop on o_current looking for OBJ_COMPLEX
@@ -255,6 +269,7 @@
* the master pin list.
* Since this fcn operates on the global sheet_data->master_pin_list,
* it doesn't return a value.
+ *
*------------------------------------------------------------------*/
void s_sheet_data_add_master_pin_list_items(OBJECT *start_obj) {
char *temp_uref;
@@ -330,8 +345,9 @@
}
-/*------------------------------------------------------------------
- * This fcn builds the master list of pin attributes. It writes
+/*------------------------------------------------------------------*/
+/*! \brief This fcn builds the master
+ * list of pin attributes. It writes
* each attrib name into the master pin attrib list.
* Algorithm:
* 1. Loop on o_current looking for OBJ_COMPLEX
@@ -342,6 +358,7 @@
* 6. Loop on attribs looking for non-NULL text.
* 7. When we find a non-NULL text attrib, extract the attrib name
* and stick it in the master pin attrib list.
+ *
*------------------------------------------------------------------*/
void s_sheet_data_add_master_pin_attrib_list_items(OBJECT *start_obj) {
char *temp_uref;
@@ -426,11 +443,12 @@
-/*------------------------------------------------------------------
- * This fcn extracts the attribs from the gtksheet
+/*------------------------------------------------------------------*/
+/*! \brief This fcn extracts the attribs from the gtksheet
* cells, and places them back into SHEET_DATA. This is the
* first step in saving out a project. Right now I just invoke
* s_table_gtksheet_to_table. Do I need to do anything else here?
+ *
*------------------------------------------------------------------*/
void s_sheet_data_gtksheet_to_sheetdata() {
s_table_gtksheet_to_all_tables();
1.10 +45 -25 eda/geda/gaf/gattrib/src/s_string_list.c
(In the diff below, changes in quantity of whitespace are not shown.)
Index: s_string_list.c
===================================================================
RCS file: /home/cvspsrv/cvsroot/eda/geda/gaf/gattrib/src/s_string_list.c,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -b -r1.9 -r1.10
--- s_string_list.c 16 Apr 2007 03:00:28 -0000 1.9
+++ s_string_list.c 16 Apr 2007 11:57:51 -0000 1.10
@@ -45,8 +45,9 @@
-/*------------------------------------------------------------------
- * This returns a pointer to a new STRING_LIST object.
+/*------------------------------------------------------------------*/
+/*! \brief This returns a pointer to a new STRING_LIST object.
+ *
*------------------------------------------------------------------*/
STRING_LIST *s_string_list_new() {
STRING_LIST *local_string_list;
@@ -61,9 +62,10 @@
}
-/*------------------------------------------------------------------
- * This takes an old string list, duplicates it and returns a pointer
+/*------------------------------------------------------------------*/
+/*! \brief This takes an old string list, duplicates it and returns a pointer
* to the new, duplicate list.
+ *
*------------------------------------------------------------------*/
STRING_LIST *s_string_list_duplicate_string_list(STRING_LIST *old_string_list) {
STRING_LIST *new_string_list;
@@ -89,8 +91,9 @@
}
-/*------------------------------------------------------------------
- * This fcn inserts the item into a char* list. It first cycles through the
+/*------------------------------------------------------------------*/
+/*! \brief This fcn inserts the item into a char* list.
+ * It first cycles through the
* list to make sure that there are no duplications. The list is assumed
* to be a STRING_LIST:
* struct STRING_LIST
@@ -100,6 +103,7 @@
* STRING_LIST *next;
* STRING_LIST *prev;
* };
+ *
*------------------------------------------------------------------*/
void s_string_list_add_item(STRING_LIST *list, int *count, char *item) {
@@ -156,10 +160,11 @@
}
-/*------------------------------------------------------------------
- * This fcn deletes an item in a STRING_LIST.
+/*------------------------------------------------------------------*/
+/*! \brief This fcn deletes an item in a STRING_LIST.
* It takes args: list to to delete item, pointer to no of items in
* list at end, and the item itself to remove.
+ *
*------------------------------------------------------------------*/
void s_string_list_delete_item(STRING_LIST **list, int *count, gchar *item) {
@@ -240,9 +245,10 @@
}
-/*------------------------------------------------------------------
- * This fcn looks for item in the list. It returns 1 if item is
+/*------------------------------------------------------------------*/
+/*! \brief This fcn looks for item in the list. It returns 1 if item is
* present, 0 if absent.
+ *
*------------------------------------------------------------------*/
int s_string_list_in_list(STRING_LIST *list, char *item) {
@@ -274,9 +280,10 @@
}
-/*------------------------------------------------------------------
- * This fcn returns the index'th item in the string list.
+/*------------------------------------------------------------------*/
+/*! \brief This fcn returns the index'th item in the string list.
* It returns NULL if there is a problem
+ *
*------------------------------------------------------------------*/
gchar *s_string_list_get_data_at_index(STRING_LIST *list, gint index)
{
@@ -301,12 +308,14 @@
}
-/*------------------------------------------------------------------
- * This fcn takes the master comp list sheet_head->master_comp_list_head
+/*------------------------------------------------------------------*/
+/*! \brief This fcn takes the master comp list
+ * sheet_head->master_comp_list_head
* and sorts it in this order:
* <all refdeses in alphabetical order>
* Right now it does nothing other than fill in the "position"
* and "length" variables.
+ *
*------------------------------------------------------------------*/
void s_string_list_sort_master_comp_list() {
int i = 0;
@@ -340,12 +349,14 @@
return;
}
-/*------------------------------------------------------------------
- * This fcn takes the master comp attrib list sheet_head->master_comp_attrib_list_head
+/*------------------------------------------------------------------*/
+/*! \brief This fcn takes the master comp attrib list
+ * sheet_head->master_comp_attrib_list_head
* and sorts it in this order:
* <all refdeses in alphabetical order>
* Right now it does nothing other than fill in the "position"
* and "length" variables.
+ *
*------------------------------------------------------------------*/
/* This list overrides the alphanumeric sort. Attribs not found in
@@ -401,10 +412,12 @@
return;
}
-/*------------------------------------------------------------------
- * This fcn takes the master net list sheet_head->master_net_list_head
+/*------------------------------------------------------------------*/
+/*! \brief This fcn takes the master net list
+ * sheet_head->master_net_list_head
* and sorts it in this order:
* <all nets in alphabetical order>
+ *
*------------------------------------------------------------------*/
void s_string_list_sort_master_net_list() {
int i = 0;
@@ -423,10 +436,13 @@
return;
}
-/*------------------------------------------------------------------
- * This fcn takes the master net attrib list sheet_head->master_net_attrib_list_head
+/*------------------------------------------------------------------*/
+/*! \brief This fcn takes the master net attrib list
+ * sheet_head->master_net_attrib_list_head
* and sorts it in this order:
- * value, footprint, model-name, file, <all other attribs in alphabetical order>
+ * value, footprint, model-name, file,
+ * <all other attribs in alphabetical order>
+ *
*------------------------------------------------------------------*/
void s_string_list_sort_master_net_attrib_list() {
int i = 0;
@@ -446,12 +462,14 @@
}
-/*------------------------------------------------------------------
- * This fcn takes the master pin list sheet_head->master_pin_list_head
+/*------------------------------------------------------------------*/
+/*! \brief This fcn takes the master pin list
+ * sheet_head->master_pin_list_head
* and sorts it in this order:
* <all refdeses in alphabetical order>
* Right now it does nothing other than fill in the "position"
* and "length" variables.
+ *
*------------------------------------------------------------------*/
void s_string_list_sort_master_pin_list() {
int i = 0;
@@ -485,12 +503,14 @@
return;
}
-/*------------------------------------------------------------------
- * This fcn takes the master pin attrib list sheet_head->master_pin_attrib_list_head
+/*------------------------------------------------------------------*/
+/*! \brief This fcn takes the master pin attrib list
+ * sheet_head->master_pin_attrib_list_head
* and sorts it in this order:
* <all pin attribs in alphabetical order>
* Right now it does nothing other than fill in the "position"
* and "length" variables.
+ *
*------------------------------------------------------------------*/
void s_string_list_sort_master_pin_attrib_list() {
int i = 0;
1.15 +36 -20 eda/geda/gaf/gattrib/src/s_table.c
(In the diff below, changes in quantity of whitespace are not shown.)
Index: s_table.c
===================================================================
RCS file: /home/cvspsrv/cvsroot/eda/geda/gaf/gattrib/src/s_table.c,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -b -r1.14 -r1.15
--- s_table.c 3 Apr 2007 11:24:31 -0000 1.14
+++ s_table.c 16 Apr 2007 11:57:51 -0000 1.15
@@ -46,14 +46,15 @@
/* =================== Public Functions ====================== */
-/*------------------------------------------------------------------
- * This fcn is the table creator. It returns a pointer to
+/*------------------------------------------------------------------*/
+/*! \brief This fcn is the table creator. It returns a pointer to
* an initialized TABLE struct. As calling args, it needs
* the number of rows and cols to allocate. The table is a
* dynamically allocated 2D array of structs. To access data in
* a cell in the table, you reference (for example):
* ((sheet_data->comp_table)[i][j]).attrib_value
* (Parens used only for clarity. It works without parens.)
+ *
*------------------------------------------------------------------*/
TABLE **s_table_new(int rows, int cols)
{
@@ -86,11 +87,13 @@
}
-/*------------------------------------------------------------------
- * This fcn recreates the table with a new size. It can only increase
+/*------------------------------------------------------------------*/
+/*! \brief This fcn recreates the table with
+ * a new size. It can only increase
* the number of cols. You can't increase the number of rows since
* gattrib doesn't allow you to input new components. Decreasing the
* number of cols is also TBD.
+ *
*------------------------------------------------------------------*/
TABLE **s_table_resize(TABLE **table,
int rows, int old_cols, int new_cols)
@@ -120,9 +123,11 @@
}
-/*------------------------------------------------------------------
- * This fcn destroys the old table. Use it after reading in a new
+/*------------------------------------------------------------------*/
+/*! \brief This fcn destroys the old table.
+ * Use it after reading in a new
* page to get rid of the old table before building a new one.
+ *
*------------------------------------------------------------------*/
void s_table_destroy(TABLE **table, int row_count, int col_count)
{
@@ -154,10 +159,12 @@
-/*------------------------------------------------------------------
- * This fcn returns the index number when given a STRING_LIST and a
+/*------------------------------------------------------------------*/
+/*! \brief This fcn returns the index number
+ * when given a STRING_LIST and a
* string to match. It finds the index
* number by iterating through the master list.
+ *
*------------------------------------------------------------------*/
int s_table_get_index(STRING_LIST *local_list, char *local_string) {
int count = 0;
@@ -181,12 +188,13 @@
-/*------------------------------------------------------------------
- * This fcn takes a table, a row list, and a row name,
+/*------------------------------------------------------------------*/
+/*! \brief This fcn takes a table, a row list, and a row name,
* and returns a list holding
* name=value pairs for all attribs pertainent to that particular
* row.
* If the row holds no attribs, it just returns NULL.
+ *
*------------------------------------------------------------------*/
STRING_LIST *s_table_create_attrib_pair(gchar *row_name,
TABLE **table,
@@ -218,10 +226,12 @@
-/*------------------------------------------------------------------
- * This fcn iterates over adds all objects found on this page looking
+/*------------------------------------------------------------------*/
+/*! \brief This fcn iterates over adds all
+ * objects found on this page looking
* for components. When it finds a component, it finds all component
* attribs and sticks them in the TABLE.
+ *
*------------------------------------------------------------------*/
void s_table_add_toplevel_comp_items_to_comp_table(OBJECT *start_obj) {
OBJECT *o_current;
@@ -323,10 +333,12 @@
}
#if 0
-/*------------------------------------------------------------------
- * This fcn iterates over adds all items found on this page looking
+/*------------------------------------------------------------------*/
+/*! \brief This fcn iterates over adds all
+ * items found on this page looking
* for nets and adds them individually to the net table. Looping over
* objects occurs here.
+ *
*------------------------------------------------------------------*/
void s_table_add_toplevel_net_items_to_net_table(OBJECT *start_obj) {
OBJECT *o_current;
@@ -406,10 +418,11 @@
#endif
-/*------------------------------------------------------------------
- * This fcn iterates over adds all items found on this page
+/*------------------------------------------------------------------*/
+/*! \brief This fcn iterates over adds all items found on this page
* looking for pins. WHen it finds a pin, it gathers all
* pin attribs and sticks them into the pin table.
+ *
*------------------------------------------------------------------*/
void s_table_add_toplevel_pin_items_to_pin_table(OBJECT *start_obj) {
OBJECT *o_current;
@@ -516,10 +529,12 @@
}
-/*------------------------------------------------------------------
- * This fcn through the spreadsheet, extracts the attribs from
+/*------------------------------------------------------------------*/
+/*! \brief This fcn through the spreadsheet,
+ * extracts the attribs from
* the cells, and places them back into TABLE. This is the
* first step in saving out a project.
+ *
*------------------------------------------------------------------*/
void s_table_gtksheet_to_all_tables() {
@@ -579,11 +594,12 @@
/* =================== Private Functions ====================== */
-/*------------------------------------------------------------------
- * This fcn does the actual heaving lifting of looping
+/*------------------------------------------------------------------*/
+/*! \brief This fcn does the actual heaving lifting of looping
* through the spreadsheet, extracting the attribs from
* the cells, and placing them back into TABLE. This is the
* first step in saving out a project.
+ *
*------------------------------------------------------------------*/
void s_table_gtksheet_to_table(GtkSheet *local_gtk_sheet, STRING_LIST *master_row_list,
STRING_LIST *master_col_list, TABLE **local_table,
_______________________________________________
geda-cvs mailing list
geda-cvs@xxxxxxxxxxxxxx
http://www.seul.org/cgi-bin/mailman/listinfo/geda-cvs