changeset 1007:870a95961b4a

Fix some of the documentation comments. Corrected spelling, filled in missing fields and some general formatting improvements.
author bsmith@81767d24-ef19-dc11-ae90-00e081727c95
date Fri, 13 May 2011 21:25:35 +0000
parents 3e1c70896c13
children f046a2712b38
files template/dw.c
diffstat 1 files changed, 8 insertions(+), 7 deletions(-) [+]
line wrap: on
line diff
--- a/template/dw.c	Wed May 11 05:12:34 2011 +0000
+++ b/template/dw.c	Fri May 13 21:25:35 2011 +0000
@@ -459,7 +459,7 @@
 }
 
 /*
- * Returns a pointer to a static buffer which containes the
+ * Returns a pointer to a static buffer which contains the
  * current user directory.  Or the root directory if it could
  * not be determined.
  */
@@ -528,9 +528,10 @@
 /*
  * Sets the contents of the default clipboard to the supplied text.
  * Parameters:
- *       Text.
+ *       str: Text to put on the clipboard.
+ *       len: Length of the text.
  */
-void dw_clipboard_set_text( char *str, int len)
+void dw_clipboard_set_text(char *str, int len)
 {
 }
 
@@ -539,9 +540,9 @@
  * Allocates and initializes a dialog struct.
  * Parameters:
  *           data: User defined data to be passed to functions.
-  * Returns:
+ * Returns:
  *       A handle to a dialog or NULL on failure.
-*/
+ */
 DWDialog * API dw_dialog_new(void *data)
 {
 #if 0
@@ -566,9 +567,9 @@
  * Parameters:
  *           dialog: Pointer to a dialog struct aquired by dw_dialog_new).
  *           result: Data to be returned by dw_dialog_wait().
-  * Returns:
+ * Returns:
  *       DW_ERROR_NONE (0) on success.
-*/
+ */
 int API dw_dialog_dismiss(DWDialog *dialog, void *result)
 {
 #if 0