chiark / gitweb /
Misc documentation fixes. Change `-ise' to `-ize' throughout.
authormdw <mdw>
Thu, 13 May 1999 22:47:57 +0000 (22:47 +0000)
committermdw <mdw>
Thu, 13 May 1999 22:47:57 +0000 (22:47 +0000)
dstr.c
dstr.h

diff --git a/dstr.c b/dstr.c
index 9093399..85fb6c0 100644 (file)
--- a/dstr.c
+++ b/dstr.c
@@ -1,6 +1,6 @@
 /* -*-c-*-
  *
- * $Id: dstr.c,v 1.4 1999/05/06 19:51:35 mdw Exp $
+ * $Id: dstr.c,v 1.5 1999/05/13 22:47:57 mdw Exp $
  *
  * Handle dynamically growing strings
  *
@@ -30,6 +30,9 @@
 /*----- Revision history --------------------------------------------------*
  *
  * $Log: dstr.c,v $
+ * Revision 1.5  1999/05/13 22:47:57  mdw
+ * Misc documentation fixes.  Change `-ise' to `-ize' throughout.
+ *
  * Revision 1.4  1999/05/06 19:51:35  mdw
  * Reformatted the LGPL notice a little bit.
  *
@@ -72,7 +75,7 @@
  *
  * Returns:    ---
  *
- * Use:                Initialises a dynamic string.
+ * Use:                Initializes a dynamic string.
  */
 
 void dstr_create(dstr *d)
@@ -212,7 +215,7 @@ void dstr_puts(dstr *d, const char *s)
  *             @const char *p@ = pointer to @printf@-style format string
  *             @va_list ap@ = argument handle
  *
- * Returns:    ---
+ * Returns:    The number of characters written to the string.
  *
  * Use:                As for @dstr_putf@, but may be used as a back-end to user-
  *             supplied functions with @printf@-style interfaces.
@@ -430,7 +433,7 @@ finished:
  *             @const char *p@ = pointer to @printf@-style format string
  *             @...@ = argument handle
  *
- * Returns:    ---
+ * Returns:    The number of characters written to the string.
  *
  * Use:                Writes a piece of text to a dynamic string, doing @printf@-
  *             style substitutions as it goes.  Intended to be robust if
@@ -559,7 +562,7 @@ int dstr_putline(dstr *d, FILE *fp)
  * Use:                Writes a dynamic string to a file.
  */
 
-size_t dstr_write(dstr *d, FILE *fp)
+size_t dstr_write(const dstr *d, FILE *fp)
 {
   return (fwrite(d->buf, 1, d->len, fp));
 }
diff --git a/dstr.h b/dstr.h
index 8ee012a..3cbabc1 100644 (file)
--- a/dstr.h
+++ b/dstr.h
@@ -1,6 +1,6 @@
 /* -*-c-*-
  *
- * $Id: dstr.h,v 1.4 1999/05/06 19:51:35 mdw Exp $
+ * $Id: dstr.h,v 1.5 1999/05/13 22:47:57 mdw Exp $
  *
  * Handle dynamically growing strings
  *
@@ -30,6 +30,9 @@
 /*----- Revision history --------------------------------------------------*
  *
  * $Log: dstr.h,v $
+ * Revision 1.5  1999/05/13 22:47:57  mdw
+ * Misc documentation fixes.  Change `-ise' to `-ize' throughout.
+ *
  * Revision 1.4  1999/05/06 19:51:35  mdw
  * Reformatted the LGPL notice a little bit.
  *
@@ -83,7 +86,7 @@ typedef struct dstr {
  *
  * Returns:    ---
  *
- * Use:                Initialises a dynamic string.
+ * Use:                Initializes a dynamic string.
  */
 
 extern void dstr_create(dstr */*d*/);
@@ -188,7 +191,7 @@ extern void dstr_puts(dstr */*d*/, const char */*s*/);
  *             @const char *p@ = pointer to @printf@-style format string
  *             @va_list ap@ = argument handle
  *
- * Returns:    ---
+ * Returns:    The number of characters written to the string.
  *
  * Use:                As for @dstr_putf@, but may be used as a back-end to user-
  *             supplied functions with @printf@-style interfaces.
@@ -202,7 +205,7 @@ extern int dstr_vputf(dstr */*d*/, const char */*p*/, va_list /*ap*/);
  *             @const char *p@ = pointer to @printf@-style format string
  *             @...@ = argument handle
  *
- * Returns:    ---
+ * Returns:    The number of characters written to the string.
  *
  * Use:                Writes a piece of text to a dynamic string, doing @printf@-
  *             style substitutions as it goes.  Intended to be robust if
@@ -287,7 +290,7 @@ extern int dstr_putline(dstr */*d*/, FILE */*fp*/);
  * Use:                Writes a dynamic string to a file.
  */
 
-extern size_t dstr_write(dstr */*d*/, FILE */*fp*/);
+extern size_t dstr_write(const dstr */*d*/, FILE */*fp*/);
 
 /*----- That's all, folks -------------------------------------------------*/