| zdoc.tcl | Lines | Comments | Arguments |
| zdoc | 22 | ||
| zdoc::analyze | 6 | run the analyze | |
| zdoc::analyze_file | 85 |
analyze a file to give its head comments, and for each proc, its head comments |
fname |
| zdoc::analyze_line | 50 |
analyze a program line - return "comment $content" or "code $content" - if line is not comment, determine _procstate: inside or outside proc and update _proclist |
line |
| zdoc::analyze_procs | 29 |
analyze known procs to describe arguments and build cross-reference |
|
| zdoc::close_filedetailheader | 5 | close the detailed documentation file of a file | fdout fname |
| zdoc::close_fileindexheader | 2 | close the file documentation in the index file | fdout fname |
| zdoc::close_procdetailtext | 2 | close the detailed proc documentation | fdout procname |
| zdoc::code_tohtml | 29 |
transform a list of code lines to html code keep white space visible |
lines |
| zdoc::comments_tohtml | 19 | transform a list of comment lines to html code | comments |
| zdoc::create_doc | 47 | files and procs being analyzed, create the documentation | |
| zdoc::get_procfile | 8 | identify the file in which a proc is stored | procname |
| zdoc::get_proclist | 31 |
get the procs of a file as a list, sorted within the option given by _procsort ("alpha" or "asintext") |
fname |
| zdoc::init | 8 | init to default values | |
| zdoc::reset | 37 | reset contents for a new run | |
| zdoc::run | 3 | run the analyze and generate the docs | |
| zdoc::set_codeprint | 3 |
set code print if yes, source code will be printed in detailed doc |
codeprint |
| zdoc::set_filelist | 7 | set the file list to analyze | filelist |
| zdoc::set_omitlines | 3 | set omit lines | omitlines |
| zdoc::set_outdir | 3 | set the output directory | outdir |
| zdoc::set_procsort | 3 |
set the order of presentation of procs alpha means alphabetic, asintext means as in the original program |
procsort |
| zdoc::set_source | 3 |
set source if yes, source code will be sourced by zdoc if no, source code must be sourced by user before analysis |
yesno |
| zdoc::set_tabsize | 3 | set tab size in number of spaces | tabsize |
| zdoc::write_filedetailheader | 11 | write the file header of the detailed file | fdout fname |
| zdoc::write_fileindexheader | 9 | write the file header of the index file | fdout fname |
| zdoc::write_procdetailtext | 92 | write the detail proc documentation | fdout procname |
| zdoc::write_procindextext | 45 | write the proc line of the index file | fdout procname |