You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

40 lines
1.6 KiB

[comment {--- punk::docgen generated from inline doctools comments ---}]
[comment {--- punk::docgen DO NOT EDIT DOCS HERE UNLESS YOU REMOVE THESE COMMENT LINES ---}]
[comment {--- punk::docgen overwrites this file ---}]
[manpage_begin punkshell_module_punk::trie 0 0.1.0]
[copyright "2010"]
[titledesc {punk::trie API}] [comment {-- Name section and table of contents description --}]
[moddesc {punk::trie}] [comment {-- Description at end of page heading --}]
[require punk::trie]
[keywords module datastructure trie]
[description] tcl trie implementation courtesy of CmcC (tcl wiki)
[para] -
[section Overview]
[para] overview of punk::trie
[subsection Concepts]
[para] -
[subsection dependencies]
[para] packages used by punk::trie
[list_begin itemized]
[item] [package {Tcl 8.6}]
[list_end]
[section API]
[subsection {Namespace punk::trie}]
[para] Core API functions for punk::trie
[list_begin enumerated]
[enum] CLASS [class trieclass]
[list_begin definitions]
[call class::trieclass [method matches] [arg t] [arg what]]
[para] search for longest prefix, return matching prefix, element and suffix
[list_end] [comment {--- end definitions ---}]
[list_end] [comment {--- end class enumeration ---}]
[subsection {Namespace punk::trie::lib}]
[para] Secondary functions that are part of the API
[list_begin definitions]
[list_end] [comment {--- end definitions namespace punk::trie::lib ---}]
[section Internal]
tcl::namespace::eval punk::trie::system {
*** !doctools
[subsection {Namespace punk::trie::system}]
[para] Internal functions that are not part of the API
[manpage_end]