Here's an example with named parameters, and namespaces (notice the preferred way of declaring namespaces and namespaced procedures). Ignore the \ in "\@param", - I had to use it so the api-browser wouldn't think the parameter docs were for ad_proc + I had to use it so the API browser wouldn't think the parameter docs were for ad_proc itself:
Index: openacs-4/packages/acs-bootstrap-installer/tcl/20-db-bootstrap-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-bootstrap-installer/tcl/20-db-bootstrap-procs.tcl,v diff -u -N -r1.10 -r1.11 --- openacs-4/packages/acs-bootstrap-installer/tcl/20-db-bootstrap-procs.tcl 7 Aug 2017 23:47:46 -0000 1.10 +++ openacs-4/packages/acs-bootstrap-installer/tcl/20-db-bootstrap-procs.tcl 21 May 2018 16:40:47 -0000 1.11 @@ -6,7 +6,7 @@ We define this here in 20-db-bootstrap-procs.tcl rather than acs-tcl/tcl/00-database-procs.tcl, as we also need to call it from db_bootstrap_set_db_type, below, and from db_bootstrap_checks, - before all the rest of the db_* api code in 00-database-procs.tcl + before all the rest of the db_* API code in 00-database-procs.tcl is sourced. @param dbn The database name to use. If empty_string, uses the default database. Index: openacs-4/packages/acs-bootstrap-installer/tcl/40-db-query-dispatcher-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-bootstrap-installer/tcl/40-db-query-dispatcher-procs.tcl,v diff -u -N -r1.47 -r1.48 --- openacs-4/packages/acs-bootstrap-installer/tcl/40-db-query-dispatcher-procs.tcl 9 May 2018 15:33:28 -0000 1.47 +++ openacs-4/packages/acs-bootstrap-installer/tcl/40-db-query-dispatcher-procs.tcl 21 May 2018 16:40:47 -0000 1.48 @@ -256,7 +256,7 @@ # Get the proc name being executed. # We catch this in case we're being called from the top level - # (eg. from bootstrap.tcl), in which case we return what we + # (e.g. from bootstrap.tcl), in which case we return what we # were given if { [catch {string trimleft [info level [expr {-1 - $added_stack_num}]] ::} proc_name] } { return [::nsf::strip_proc_name $local_name] Index: openacs-4/packages/acs-templating/tcl/head-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/tcl/head-procs.tcl,v diff -u -N -r1.38 -r1.39 --- openacs-4/packages/acs-templating/tcl/head-procs.tcl 18 May 2018 07:56:07 -0000 1.38 +++ openacs-4/packages/acs-templating/tcl/head-procs.tcl 21 May 2018 16:40:47 -0000 1.39 @@ -74,7 +74,7 @@ @param section section, where script is added ("head" or "body") @param src the src attribute of the script tag, ie. the source url of the script - @param type the type attribute of the script tag, eg. 'text/javascript' + @param type the type attribute of the script tag, e.g. 'text/javascript' } { if {$section eq "head"} { # @@ -125,7 +125,7 @@ parameter will be ignored if a value has been supplied for src @param src the src attribute of the script tag, ie. the source url of the script - @param type the type attribute of the script tag, eg. 'text/javascript' + @param type the type attribute of the script tag, e.g. 'text/javascript' } { if {$defer_p} { @@ -208,7 +208,7 @@ @param crossorigin Enumerated attribute to indicate whether CORS (Cross-Origin Resource Sharing) should be used - @param href the href attribute of the link tag, eg. the target document + @param href the href attribute of the link tag, e.g. the target document of the link @param integrity provide hash values for W3C Subresource Integrity recommendation @param lang the lang attribute of the link tag specifying the language @@ -217,11 +217,11 @@ media this link is relevant to. This may be a comma @param order specify inclusion order @param rel the rel attribute of the link tag defining the relationship - of the linked document to the current one, eg. 'stylesheet' + of the linked document to the current one, e.g. 'stylesheet' @param title the title attribute of the link tag describing the target of this link - @param type the type attribute of the link tag, eg. 'text/css' - separated list of values, eg. 'screen,print,braille' + @param type the type attribute of the link tag, e.g. 'text/css' + separated list of values, e.g. 'screen,print,braille' @see ::template::head::flush_link } { @@ -237,12 +237,12 @@ @author Gustaf Neumann @creation-date 2018-03-09 - @param href the href attribute of the link tag, eg. the target document + @param href the href attribute of the link tag, e.g. the target document of the link. A glob pattern similar link in "string match" can be provided. @param rel the rel attribute of the link tag defining the relationship - of the linked document to the current one, eg. 'stylesheet' + of the linked document to the current one, e.g. 'stylesheet' @see ::template::head::add_link } { array unset ::template::head::links $rel,$href @@ -326,12 +326,12 @@ @param http_equiv the http-equiv attribute of the meta tag, ie. the HTTP header which this metadata is equivalent to - eg. 'content-type' + e.g. 'content-type' @param name the name attribute of the meta tag, ie. the metadata identifier @param scheme the scheme attribute of the meta tag defining which metadata scheme should be used to interpret the metadata, - eg. 'DC' for Dublin Core (http://dublincore.org/) + e.g. 'DC' for Dublin Core (http://dublincore.org/) @param content the content attribute of the meta tag, ie the metadata value @param lang the lang attribute of the meta tag specifying the language @@ -366,10 +366,10 @@ @creation-date 2007-11-30 @param style CSS content to be included in the style tag - @param type the type attribute of the link tag, eg. 'text/css' + @param type the type attribute of the link tag, e.g. 'text/css' @param media the media attribute of the link tag describing which display media this link is relevant to. This may be a comma - separated list of values, eg. 'screen,print,braille' + separated list of values, e.g. 'screen,print,braille' @param title the title attribute of the link tag describing the target of this link @param lang the lang attribute of the link tag specifying the language @@ -451,14 +451,14 @@ subsequent calls to add_css will replace the existing entry. This function is a wrapper around template::head::add_link. - @param href the href attribute of the link tag, eg. the target + @param href the href attribute of the link tag, e.g. the target stylesheet @param alternate sets the rel attribute of the link tag defining to 'alternate stylesheet' if set, sets it to 'stylesheet' otherwise @param media the media attribute of the link tag describing which display media this link is relevant to. This may be a - comma separated list of values, eg. 'screen,print,braille' + comma separated list of values, e.g. 'screen,print,braille' @param title the title attribute of the link tag describing the target of this link @param lang the lang attribute of the link tag specifying the language @@ -555,7 +555,7 @@ src @param src the src attribute of the script tag, ie. the source url of the script - @param type the type attribute of the script tag, eg. 'text/javascript' + @param type the type attribute of the script tag, e.g. 'text/javascript' } { if {$defer_p} { Index: openacs-4/packages/acs-templating/tcl/parse-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/tcl/parse-procs.tcl,v diff -u -N -r1.62 -r1.63 --- openacs-4/packages/acs-templating/tcl/parse-procs.tcl 24 Apr 2018 17:45:41 -0000 1.62 +++ openacs-4/packages/acs-templating/tcl/parse-procs.tcl 21 May 2018 16:40:47 -0000 1.63 @@ -812,7 +812,7 @@ @creation-date 2002-01-30 @return the tag identifier for the enclosing tag - @param tag the type (eg. multiple) of the enclosing tag to look for. + @param tag the type (e.g. multiple) of the enclosing tag to look for. } { set name "" Index: openacs-4/packages/acs-templating/tcl/spellcheck-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/tcl/spellcheck-procs.tcl,v diff -u -N -r1.26 -r1.27 --- openacs-4/packages/acs-templating/tcl/spellcheck-procs.tcl 9 May 2018 15:33:29 -0000 1.26 +++ openacs-4/packages/acs-templating/tcl/spellcheck-procs.tcl 21 May 2018 16:40:47 -0000 1.27 @@ -172,7 +172,7 @@ @param html_p Does the text have html in it? If so, we strip out html tags in the string we feed to ispell (or aspell). @param no_abort_p Set this tue for testing purposes (e.g. aa_test). - @param var_to_spellcheck The name of the text input type or textarea that holds this text (eg., "email_body") + @param var_to_spellcheck The name of the text input type or textarea that holds this text (e.g., "email_body") } { Index: openacs-4/packages/acs-templating/www/doc/guide/wizard-procs-doc.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/guide/wizard-procs-doc.adp,v diff -u -N -r1.5 -r1.6 --- openacs-4/packages/acs-templating/www/doc/guide/wizard-procs-doc.adp 25 Apr 2018 08:42:18 -0000 1.5 +++ openacs-4/packages/acs-templating/www/doc/guide/wizard-procs-doc.adp 21 May 2018 16:40:47 -0000 1.6 @@ -39,7 +39,7 @@