Overview | Index by: file name |
procedure name |
procedure call |
annotation
:
1
A
B
C
D
E
F
G
H
I
J
K
L
M
N
O
P
Q
R
S
T
U
V
W
X
Y
Z
Index of annotations
-
- add_file_annotation { header } -
tcldoc_scanner.tcl
- Given the file-level comment (with //# markings
removed) scans it for tags.
- add_proc_annotation { header procname procargs procline } -
tcldoc_scanner.tcl
- Given a procedure-level comment scans it for tags.
- add_summary { entry target arguments source description type } -
tcldoc.tcl
- Adds an entry to the global summary table.
-
- BEGIN { new_state {prefix yy} } -
tcldoc_scanner.tcl
- BEGIN followed by the name of a start condition places the scanner
in the corresponding start condition.
-
- declaration_scan { filename } -
tcldoc.tcl
- Scans a file for all instances of lines beginning with
proc indicating a procedure declaration.
- deep_scan { filename } -
tcldoc.tcl
- Take a single source Tcl file and scan it intensively, generating
its HTML version.
-
- ECHO { {s {}} } -
tcldoc_scanner.tcl
- ECHO copies yytext to the scanner's output if no arguments are
given.
-
- filecomp { a b } -
tcldoc.tcl
- Compares the last part of a filename
- flatten_args { x } -
tcldoc.tcl
- Given an arbitrary length list (such as the one supplying arguments
to a procedure declaration) remove excess spaces between arguments.
-
- get_param { param_list param_num param_name } -
tcldoc.tcl
- Retrives a parameter from the options list.
- get_summary { text } -
tcldoc_scanner.tcl
- Determines the summary line given the file/procedure information.
- glob_all { dir exts } -
tcldoc.tcl
- Glob recursively across a directory and its subdirectory for all
files matching a list of extensions.
-
- initialize_tables { } -
tcldoc.tcl
- Initialize all of the various cross-reference tables used by TclDoc.
- input { } -
tcldoc_scanner.tcl
- input() reads the next character from the input stream.
- interp_link { text tag } -
tcldoc_scanner.tcl
- Helper function to the scanner that takes the arguments to a
@link or the third form of @see and splits
it into its component parts.
-
- lookup_procrecord { procname basename } -
tcldoc.tcl
- Given a procedure name, look up within the procedure table for its
declaration.
-
- new_annotation { dest basename annothtmlname docroot } -
tcldoc_scanner.tcl
- Flushes internal tables in preparation for writing a new annotation
file.
-
- path_lookup { orig_file } -
tcldoc.tcl
- Given a filename returns the location of where its TclDoc'ed files
are located.
- prepare_destination { } -
tcldoc.tcl
- Creates the destination directory as necessary.
- print_status { args } -
tcldoc.tcl
- If running in verbose mode print to standard output its arguments.
- print_tcldoc_help { chan } -
tcldoc.tcl
- Print TclDoc's usage to a
-
- sanitize { s } -
tcldoc.tcl
- Given some text, replaces potentially dangerous characters with
their HTML character code.
- scan_recursively { dest buffer basename annotname } -
tcldoc.tcl
- Given a buffer of Tcl code recursively examine each command within.
-
- tcldoc.tcl -
file found in
.
- TclDoc parses the declarations and documentation comments in a set
of Tcl source files and produces a corresponding set of HTML pages
describing procedure declarations.
- tcldoc_args { argv } -
tcldoc.tcl
- Parse the command line and set global
- tcldoc_error { message {returnvalue -1} } -
tcldoc.tcl
- Called to abort TclDoc upon all other errors.
- tcldoc_file_error { message } -
tcldoc.tcl
- Called to abort whenever TclDoc discovers a problem with a
particular input file.
- tcldoc_file_warning { message } -
tcldoc.tcl
- Called whenever TclDoc found a problem with a file, particularly
something that it could not parse.
- tcldoc_main { } -
tcldoc.tcl
- Actually run TclDoc across requested files and directories.
- tcldoc_scanner.tcl -
file found in
.
- Handles scanning of file-level and procedure-level comments.
-
- unput { c } -
tcldoc_scanner.tcl
- unput(c) puts the character c back onto the input stream.
-
- write_and_update { dest output } -
tcldoc.tcl
- Writes to channel $dest the contents of
$output.
- write_annotation { } -
tcldoc_scanner.tcl
- Actually writes the annotation file to disk at the location
specified in a previous call to new_annotation.
- write_export_file { } -
tcldoc.tcl
-
- write_footer { dest } -
tcldoc.tcl
- Output a common header for HTML-ized Tcl files.
- write_header { dest basename title } -
tcldoc.tcl
- Outputs a common header for HTML-ized Tcl
- write_index_annotations { } -
tcldoc.tcl
- Write two indices of all declared procedures and source files.
- write_index_bycall { mainindex } -
tcldoc.tcl
- Write the index of procedure calls.
- write_index_byfile { mainindex } -
tcldoc.tcl
- Write the index of filenames.
- write_index_byproc { mainindex } -
tcldoc.tcl
- Write the index of procedures.
- write_index_footer { dest } -
tcldoc.tcl
- Outputs a common footer for the various generated index
- write_index_header { dest page_title index_line {page_header {}} } -
tcldoc.tcl
- Outputs a common header for the various generated index
- write_index_master { } -
tcldoc.tcl
- Writes the overall
-
- YY_FLUSH_BUFFER { } -
tcldoc_scanner.tcl
- YY_FLUSH_BUFFER flushes the scanner's internal buffer so that the
next time the scanner attempts to match a token, it will first
refill the buffer using YY_INPUT.
- YY_INPUT { buf result max_size } -
tcldoc_scanner.tcl
- The nature of how it gets its input can be controlled by defining
the YY_INPUT macro.
- yy_pop_state { } -
tcldoc_scanner.tcl
- Pops off the top of the state stack; if the stack is now empty, then
pushes the state "INITIAL".
- yy_push_state { new_state } -
tcldoc_scanner.tcl
- Pushes the current start condition onto the top of the start
condition stack and switches to new_state as though you had used
BEGIN new_state.
- yy_scan_string { str } -
tcldoc_scanner.tcl
- yy_scan_string sets up input buffers for scanning in-memory
strings instead of files.
- yy_top_state { } -
tcldoc_scanner.tcl
- Returns the top of the stack without altering the stack's contents.
- yyless { n } -
tcldoc_scanner.tcl
- Returns all but the first n characters of the current token back to
the input stream, where they will be rescanned when the scanner
looks for the next match.
- yylex { } -
tcldoc_scanner.tcl
- Whenever yylex() is called, it scans tokens from the global input
file yyin (which defaults to stdin).
- yyrestart { new_file } -
tcldoc_scanner.tcl
- yyrestart(new_file) may be called to point yyin at the new input
file.
- yywrap { } -
tcldoc_scanner.tcl
- If yywrap() returns false (zero), then it is assumed that the
function has gone ahead and set up yyin to point to another input
file, and scanning continues.
Overview | Index by: file name |
procedure name |
procedure call |
annotation
File generated 2019-02-05 at 11:21.