comparison template/dw.c @ 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 56077b50be7e
children f046a2712b38
comparison
equal deleted inserted replaced
1006:3e1c70896c13 1007:870a95961b4a
457 { 457 {
458 free(ptr); 458 free(ptr);
459 } 459 }
460 460
461 /* 461 /*
462 * Returns a pointer to a static buffer which containes the 462 * Returns a pointer to a static buffer which contains the
463 * current user directory. Or the root directory if it could 463 * current user directory. Or the root directory if it could
464 * not be determined. 464 * not be determined.
465 */ 465 */
466 char *dw_user_dir(void) 466 char *dw_user_dir(void)
467 { 467 {
526 } 526 }
527 527
528 /* 528 /*
529 * Sets the contents of the default clipboard to the supplied text. 529 * Sets the contents of the default clipboard to the supplied text.
530 * Parameters: 530 * Parameters:
531 * Text. 531 * str: Text to put on the clipboard.
532 */ 532 * len: Length of the text.
533 void dw_clipboard_set_text( char *str, int len) 533 */
534 void dw_clipboard_set_text(char *str, int len)
534 { 535 {
535 } 536 }
536 537
537 538
538 /* 539 /*
539 * Allocates and initializes a dialog struct. 540 * Allocates and initializes a dialog struct.
540 * Parameters: 541 * Parameters:
541 * data: User defined data to be passed to functions. 542 * data: User defined data to be passed to functions.
542 * Returns: 543 * Returns:
543 * A handle to a dialog or NULL on failure. 544 * A handle to a dialog or NULL on failure.
544 */ 545 */
545 DWDialog * API dw_dialog_new(void *data) 546 DWDialog * API dw_dialog_new(void *data)
546 { 547 {
547 #if 0 548 #if 0
548 DWDialog *tmp = malloc(sizeof(DWDialog)); 549 DWDialog *tmp = malloc(sizeof(DWDialog));
549 550
564 * Accepts a dialog struct and returns the given data to the 565 * Accepts a dialog struct and returns the given data to the
565 * initial called of dw_dialog_wait(). 566 * initial called of dw_dialog_wait().
566 * Parameters: 567 * Parameters:
567 * dialog: Pointer to a dialog struct aquired by dw_dialog_new). 568 * dialog: Pointer to a dialog struct aquired by dw_dialog_new).
568 * result: Data to be returned by dw_dialog_wait(). 569 * result: Data to be returned by dw_dialog_wait().
569 * Returns: 570 * Returns:
570 * DW_ERROR_NONE (0) on success. 571 * DW_ERROR_NONE (0) on success.
571 */ 572 */
572 int API dw_dialog_dismiss(DWDialog *dialog, void *result) 573 int API dw_dialog_dismiss(DWDialog *dialog, void *result)
573 { 574 {
574 #if 0 575 #if 0
575 dialog->result = result; 576 dialog->result = result;
576 dw_event_post(dialog->eve); 577 dw_event_post(dialog->eve);