called by parse_namespace

Parameters:

proc_block

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Parse API documentation from a Tcl page API documentation is parsed as follows:

• Document is scanned until a @namespace directive is encountered. The remainder of the file is scanned for @private or @public directives.
• When one of these directives is encountered, the file is scanned up to a proc declaration and the text in between is parsed as documentation for a single procedure.
• The text between the initial @private or @public directive and the next directive is considered a general comment on the procedure

• @author
• @param (for hard parameters)
• @see (should have the form namespace::procedure. A reference to an entire namespace should be namespace::. By convention the API for each namespace should be in a file of the same name, so that a link can be generated automatically).
• @option (for switches such as -foo)
• @return

Reads the text for a file and scans for a namespace directive. When one is encountered, reads until the next namespace or EOF and calls doc::parse_namespace on the accumulated lines to get procedure documentation.

creates a multirow variable in the variable name designated by result_ref with columns namespace_name, proc_name, public_private, author, param, option, see, return and source_text

Note that this format is suitable for passing to array set for creating a lookup on namespace name.

Parameters:

path

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

text between two namespace markers in a Tcl library file and parses out procedure source and comments

Parameters:

text_lines - namespace text body

Author:

simon

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

takes the absolute path of the Tcl library directory and parses through it

Parameters:

dir_list

Returns:

a long lists of lists of lists, each list element contains a three-element list of the format - { {info} {public procedures listing } {private procedures listing}}

See Also:

• doc::parse_file
• template::util::comment_text_normalize

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

called by parse_comment_text

Parameters:

proc_block

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

procedure to deal with @see comments

Parameters:

list_ref
directive_comments

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

puts a space after all closing curly brackets, does not add a space when brackets are already followed by a space

Parameters:

text

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Parameters:

text

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

escapes out all square brackets

Parameters:

text

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

given a body of text and a text marker, returns a list of position indices for each occurrence of the text marker

Parameters:

text - body of text to be searched through
marker - the text-divider mark

Returns:

list of indices of the position immediately preceding each occurrence of the text marker; if there are no occurrences of the text marker, returns a zero-element list

See Also:

• namespace doc
• doc::parse_file
• doc::parse_namespace
• doc::util::text_divider

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Parameters:

text_ref

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

used to sort the see list, which has structure [name {name} type {type} url {url}]

Parameters:

element1 - the first of the two list elements to be compared
element2 - {default actually, no default value for this because it is required} the second of the two elements to be compared

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

divides a string variable into a list of strings, all but the first element beginning with the indicated text marker; the first element of the created list contains all of the string preceding the first occurrence of the text marker

Parameters:

text_ref - name of string variable (not the string value itself)
marker - the string indicating text division

See Also:

• doc::util::find_marker_indices

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

takes an alphabetized list and an entry

Parameters:

list - {let's see how this parses out} the alphabetized list
entry - req the value to be inserted

Returns:

either the proper list index for an alphabetized insertion or -1 if the entry is already in the list

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

escapes quotes and removes comment tags from a body of commented text

Parameters:

text

Returns:

text

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

used to compare two different elements in a list of parsed data for public or private procs

Parameters:

element1
element2

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

just takes a body of text and puts a space behind every double quote; this is done so that the text body can be treated as a list without causing problems resulting from list elements being separated by characters other than a space

Parameters:

text - req/none the body of text to be worked on

Returns:

same text but with a space behind each quote; double quotes that are already trailed by a space are unaffected

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

takes a .adp template name and the name of the file to be written and creates the file; also puts out a notice before

Parameters:

template - the name of the template to be used in making the file
file_name - the name of the file to be created

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.