fix the quickfill docos

git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@9996 57a11ea4-9604-0410-9ed3-97b8803252fd
This commit is contained in:
Linas Vepstas 2004-05-31 14:57:31 +00:00
parent fe39e2717b
commit 2079c5f7f6

View File

@ -28,22 +28,23 @@
#include <gdk/gdk.h> #include <gdk/gdk.h>
#include <glib.h> #include <glib.h>
/** /** @addtogroup QuickFill
* @file QuickFill.h QuickFill is meant to be used to quickly auto-complete typed
* @breif Quickfill is used to auto-complete typed user entries. user input. Quickfill is implemented as a heirarchical tree
* @author Copyright (C) 1997 Robin D. Clark of partial matching strings. The root of the tree contains
* @author Copyright (C) 1998,2004 Linas Vepstas <linas@linas.org> all of the strings that user input should be matched to.
* @author Copyright (C) 2000 Dave Peticolas Then, given a short string segment, quickfill will return
* a subtree containing only those strings that start with desired
* QuickFill is meant to be used to quickly auto-complete typed substring. As additional letters are added to the substring,
* user input. Quickfill is implemented as a heirarchical tree Quickfill will thus narrow down to the unique matching string
* of partial matching strings. The root of the tree contains (or to nothing if no match).
* all of the strings that user input should be matched to. @{
* Then, given a short string segment, quickfill will return
* a subtree containing only those strings that start with desired @file QuickFill.h
* substring. As additional letters are added to the substring, @breif Quickfill is used to auto-complete typed user entries.
* Quickfill will thus narrow down to the unique matching string @author Copyright (C) 1997 Robin D. Clark
* (or to nothing if no match). @author Copyright (C) 1998,2004 Linas Vepstas <linas@linas.org>
@author Copyright (C) 2000 Dave Peticolas
*/ */
typedef enum typedef enum
@ -55,7 +56,7 @@ typedef enum
typedef struct _QuickFill QuickFill; typedef struct _QuickFill QuickFill;
/** PROTOTYPES ******************************************************/ /* PROTOTYPES ******************************************************/
QuickFill * gnc_quickfill_new (void); QuickFill * gnc_quickfill_new (void);
void gnc_quickfill_destroy (QuickFill *qf); void gnc_quickfill_destroy (QuickFill *qf);
@ -116,4 +117,5 @@ void gnc_quickfill_insert (QuickFill *root, const char *text,
void gnc_quickfill_insert_wc (QuickFill *root, const GdkWChar *text, void gnc_quickfill_insert_wc (QuickFill *root, const GdkWChar *text,
QuickFillSort sort_code); QuickFillSort sort_code);
/** @} */
#endif /* QUICKFILL_H */ #endif /* QUICKFILL_H */