called by parse_file, this procedure is given the body
-of text between two namespace markers in a tcl library file and
+of text between two namespace markers in a Tcl library file and
parses out procedure source and comments -
-Parameters:
+Parameters:
text_lines*
| namespace text body |
-
+
| 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
@@ -39,20 +45,22 @@
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 |
-
+
|
called by parse_comment_text -
-Parameters:
+Parameters:
comment_text*
| this should include the source text |
-
+
|
called by parse_namespace -
-Parameters:
+Parameters:
comment_text*
@@ -65,17 +73,18 @@
|
-
+
|
-takes the absolute path of the tcl library directory
+takes the absolute path of the Tcl library directory
and parses through it
-- Returns:
- a long lists of lists of lists, each list element contains a
+
- 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:
- namespace - util
+listing } {private procedures listing} } - See Also:
- namespace - util
- proc - doc::parse_file
template::util::comment_text_normalize
|
-
+
|
+
* indicates required
-
|
|