[Author Prev][Author Next][Thread Prev][Thread Next][Author Index][Thread Index]

gEDA-user: comments in gedalib/src/attrib.c



Finally, I managed to come to terms with git :-)

Attached is a patch for comments in gaf/gedalib/src/attrib.c
It corrects were some typos and copy paste accidents in comments. 

---<(kaimartin)>---
-- 
Kai-Martin Knaak
Email: kmk@xxxxxxxxxxxxxxx
Öffentlicher PGP-Schlüssel:
http://pgp.mit.edu:11371/pks/lookup?op=get&search=0x6C0B9F53

From 83d9e75322b01dfe22b388f53c45165431652c27 Mon Sep 17 00:00:00 2001
From: Kai-Martin Knaak <kmk@xxxxxxxxxxxx>
Date: Tue, 28 Jul 2009 22:42:16 +0200
Subject: [PATCH] Comments more to the point.

modified:   ../libgeda/src/o_attrib.c

---<(kaimartin)>---

---
 libgeda/src/o_attrib.c |   18 +++++++++---------
 1 files changed, 9 insertions(+), 9 deletions(-)

diff --git a/libgeda/src/o_attrib.c b/libgeda/src/o_attrib.c
index a550126..117ff91 100644
--- a/libgeda/src/o_attrib.c
+++ b/libgeda/src/o_attrib.c
@@ -65,7 +65,7 @@
  *  \param [in]  toplevel   The TOPLEVEL object.
  *  \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.
+ *  \return nothing.
  */
 void o_attrib_add(TOPLEVEL *toplevel, OBJECT *object, OBJECT *item)
 {
@@ -449,7 +449,7 @@ GList *o_attrib_find_floating_attribs (const GList *list)
 }
 
 
-/*! \brief Search for attibute by name.
+/*! \brief Find an attribute in a list.
  *  \par Function Description
  *  Search for attribute by name.
  *
@@ -491,7 +491,7 @@ static OBJECT *o_attrib_find_attrib_by_name (const GList *list, char *name, int
 }
 
 
-/*! \brief Search for attibute by name.
+/*! \brief Search attribute list by name.
  *  \par Function Description
  *  Search for attribute by name.
  *
@@ -501,7 +501,7 @@ static OBJECT *o_attrib_find_attrib_by_name (const GList *list, char *name, int
  *  \param [in] list     GList of attributes to search.
  *  \param [in] name     Character string with attribute name to search for.
  *  \param [in] counter  Which occurance to return.
- *  \return The n'th attribute object in the given list with the given name.
+ *  \return Character string with attribute value, NULL otherwise.
  */
 static char *o_attrib_search_attrib_list_by_name (const GList *list, char *name, int counter)
 {
@@ -517,7 +517,7 @@ static char *o_attrib_search_attrib_list_by_name (const GList *list, char *name,
 }
 
 
-/*! \brief Search for attibute by name.
+/*! \brief Search floating attribute by name.
  *  \par Function Description
  *  Search for attribute by name.
  *
@@ -545,7 +545,7 @@ char *o_attrib_search_floating_attribs_by_name (const GList *list, char *name, i
 }
 
 
-/*! \brief Search for attibute by name.
+/*! \brief Search attached attributes by name.
  *  \par Function Description
  *  Search for attribute by name.
  *
@@ -566,7 +566,7 @@ char *o_attrib_search_attached_attribs_by_name (OBJECT *object, char *name, int
 }
 
 
-/*! \brief Search for attibute by name.
+/*! \brief Search inherited attribute by name.
  *  \par Function Description
  *  Search for attribute by name.
  *
@@ -590,14 +590,14 @@ char *o_attrib_search_inherited_attribs_by_name (OBJECT *object, char *name, int
 }
 
 
-/*! \brief Search for attibute by name.
+/*! \brief Search attributes of object by name.
  *  \par Function Description
  *  Search for attribute by name.
  *
  *  Counter is the n'th occurance of the attribute, and starts searching
  *  from zero.  Zero is the first occurance of an attribute.
  *
- *  \param [in] list     OBJECT whos attributes to search.
+ *  \param [in] object   OBJECT who's attributes to search.
  *  \param [in] name     Character string with attribute name to search for.
  *  \param [in] counter  Which occurance to return.
  *  \return Character string with attribute value, NULL otherwise.
-- 
1.6.3.3


Attachment: pgpWnTwwgxCAl.pgp
Description: PGP signature


_______________________________________________
geda-user mailing list
geda-user@xxxxxxxxxxxxxx
http://www.seul.org/cgi-bin/mailman/listinfo/geda-user