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.
44 lines
1.5 KiB
44 lines
1.5 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 shellspy_module_pipe 0 1.0] |
|
[copyright "2025"] |
|
[titledesc {Module API}] [comment {-- Name section and table of contents description --}] |
|
[moddesc {-}] [comment {-- Description at end of page heading --}] |
|
[require pipe] |
|
[keywords module] |
|
[description] |
|
[para] - |
|
[section Overview] |
|
[para] overview of pipe |
|
[subsection Concepts] |
|
[para] - |
|
[subsection dependencies] |
|
[para] packages used by pipe |
|
[list_begin itemized] |
|
[item] [package {Tcl 8.6}] |
|
[list_end] |
|
[section API] |
|
[subsection {Namespace pipe::class}] |
|
[para] class definitions |
|
if {[tcl::info::commands [tcl::namespace::current]::interface_sample1] eq ""} { |
|
*** !doctools |
|
[list_begin enumerated] |
|
[list_end] [comment {--- end class enumeration ---}] |
|
} |
|
} |
|
++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +++ |
|
[subsection {Namespace pipe}] |
|
[para] Core API functions for pipe |
|
[list_begin definitions] |
|
[list_end] [comment {--- end definitions namespace pipe ---}] |
|
[subsection {Namespace pipe::lib}] |
|
[para] Secondary functions that are part of the API |
|
[list_begin definitions] |
|
[list_end] [comment {--- end definitions namespace pipe::lib ---}] |
|
[section Internal] |
|
tcl::namespace::eval pipe::system { |
|
*** !doctools |
|
[subsection {Namespace pipe::system}] |
|
[para] Internal functions that are not part of the API |
|
[manpage_end]
|
|
|