- Publicity: Public Only All
doc-procs.tcl
Procedures in this file
- doc::func_list (private, deprecated)
- doc::func_multirow (private, deprecated)
- doc::get_proc_doc (private, deprecated)
- doc::get_proc_header (private, deprecated)
- doc::package_info (private, deprecated)
- doc::package_list (private, deprecated)
- doc::parse_proc_header (private, deprecated)
Detailed information
doc::func_list (private, deprecated)
doc::func_list package_name [ db ]
Deprecated. Invoking this procedure generates a warning.
Return a list of all the function creation headers in a package, in form { value value ... }
- Parameters:
- package_name (required)
- db (optional)
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
doc::func_multirow (private, deprecated)
doc::func_multirow package_name result_ref [ db ]
Deprecated. Invoking this procedure generates a warning.
Return a multirow datatsource for all the functions { value value ... }
- Parameters:
- package_name (required)
- result_ref (required)
- db (optional)
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
doc::get_proc_doc (private, deprecated)
doc::get_proc_doc proc_name package_name param_ref tags_ref code_ref \
[ args... ]Deprecated. Invoking this procedure generates a warning.
Query the database and prepare the datasources The user should call this procedure
- Parameters:
- proc_name (required)
- package_name (required)
- param_ref (required)
- tags_ref (required)
- code_ref (required)
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
doc::get_proc_header (private, deprecated)
doc::get_proc_header proc_name package_name doc_ref code_ref [ db ]
Deprecated. Invoking this procedure generates a warning.
Retrieve the function header for a specific function and parse out the javadoc comment.
- Parameters:
- proc_name (required)
- package_name (required)
- doc_ref (required)
- code_ref (required)
- db (optional)
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
doc::package_info (private, deprecated)
doc::package_info package_name info_ref
Deprecated. Invoking this procedure generates a warning.
Set up a data source with overall package info (overview, see also, etc.)
- Parameters:
- package_name (required)
- info_ref (required)
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
doc::package_list (private, deprecated)
doc::package_list [ db ]
Deprecated. Invoking this procedure generates a warning.
Return a list of all the packages in the data model, in form { {label value} {label value} ... }
- Parameters:
- db (optional)
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
doc::parse_proc_header (private, deprecated)
doc::parse_proc_header doc_block code_block param_ref tags_ref \
code_ref [ level ]Deprecated. Invoking this procedure generates a warning.
Parse the header block and prepare the datasources: Prepare a multirow datasource for the param tags Prepare a onerow datasource for all the other tags
- Parameters:
- doc_block (required)
- code_block (required)
- param_ref (required)
- tags_ref (required)
- code_ref (required)
- level (optional, defaults to
"2")- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
