Index: openacs-4/packages/acs-templating/www/doc/gen/proc-doc.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/gen/proc-doc.adp,v diff -u -r1.8.2.2 -r1.8.2.3 --- openacs-4/packages/acs-templating/www/doc/gen/proc-doc.adp 13 Jul 2023 12:48:33 -0000 1.8.2.2 +++ openacs-4/packages/acs-templating/www/doc/gen/proc-doc.adp 2 Sep 2024 09:40:25 -0000 1.8.2.3 @@ -2,6 +2,10 @@ {/doc/acs-templating/ {ACS Templating}} {Commenting Tcl procedures for parsing} Commenting Tcl procedures for parsing +

Using comments to document Tcl procedures

Templating System

Text divisions, grouping

@@ -12,6 +16,7 @@ divisions has its own text marker(s). In the end, your Tcl file should look something like this:

+
 [------------------------------------------------------]
 [------  ignored text at beginning of file  -----------]
 [------------------------------------------------------]
@@ -109,7 +114,8 @@
 will be marked as required if it is a parameter, or
 display no information if it is an option.
 

For example: the fictional procedure grant_permission might be -preceded by these comments:

# \@public grant_permission
+preceded by these comments:


+# \@public grant_permission
 # checks for whether or not a user has the privilege 
 # to manipulate an object in a specific manner