aniani/profanity
1
0
Fork 0
mirror of https://github.com/profanity-im/profanity.git synced 2024-12-04 14:46:46 -05:00
Code

Added more code documentation

Browse Source
This commit is contained in:
James Booth 2012-05-22 00:38:04 +01:00
parent 95dbb68b38
commit 7e62076347
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
DESIGN
View File

@ -163,4 +163,19 @@ The idea is that these modules could be included in other applications.
The "prof_" prefix is just because they were created whilst developing
Profanity.
prof_autocomplete.c
-------------------
Two type are PAutocomplete can be created.
p_autocomplete_new() creates a PAutocomplete that can store strings, the
simple case.
p_obj_autocomplete_new() creates a PAutocomplete of arbitrary data
structures. This function must be passed function pointers of the following
types:
PStrFunc: A function that will get a string out of the data structure
PCopyFunc: A function that will make a copy the data structure, allocating
memory for it.
GDestroyNotify: A function that will free memory for the data structure.