# HG changeset patch # User bsmith@81767d24-ef19-dc11-ae90-00e081727c95 # Date 1305321935 0 # Node ID 870a95961b4a659bea3ae57e3f66b9f8e68d8ba3 # Parent 3e1c70896c13313a771bf130c038dc646dbc8a59 Fix some of the documentation comments. Corrected spelling, filled in missing fields and some general formatting improvements. diff -r 3e1c70896c13 -r 870a95961b4a template/dw.c --- 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