Index: openacs-4/packages/acs-bootstrap-installer/tcl/00-proc-procs.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-bootstrap-installer/tcl/00-proc-procs.tcl,v
diff -u -r1.6 -r1.7
--- openacs-4/packages/acs-bootstrap-installer/tcl/00-proc-procs.tcl 13 May 2002 04:36:32 -0000 1.6
+++ openacs-4/packages/acs-bootstrap-installer/tcl/00-proc-procs.tcl 13 Sep 2002 20:10:45 -0000 1.7
@@ -375,22 +375,29 @@
-deprecated:boolean
-warn:boolean
arg_list
- args
+ [doc_string]
+ body
} {
+ Declare a procedure.
- Declares a procedure.
+ Documentation may contain tags which will be parsed for display in
+ the api browser. Some tags are @param, @return, @error, @see, @author
+ (probably this should be better documented).
@param public specifies that the procedure is part of a public API.
@param private specifies that the procedure is package-private.
@param deprecated specifies that the procedure should not be used.
- @param warn specifies that the procedure should generate a warning when invoked.
+ @param warn specifies that the procedure should generate a warning when invoked (requires that
+ -deprecated also be set)
@param arg_list the list of switches and positional parameters which can be
provided to the procedure.
-
+ @param [doc_string] documentation for the procedure (optional, but greatly desired).
+ @param body the procedure body. Documentation may be provided for an arbitrary function
+ by passing the body as a "-".
+
} -
ad_proc -public ad_arg_parser { allowed_args argv } {
-
Parses an argument list for a database call (switches at the end).
Switch values are placed in corresponding variable names in the calling
environment.
@@ -482,16 +489,16 @@
docblock
body
} {
+ Defines a method for type based dispatch. This method can be
+ called using ad_call_method
. The first arg to the
+ method is the target on which the type dispatch happens. Use this
+ with care.
+
@param method_name the method name
@param type the type for which this method will be used
@param argblock the argument description block, is passed to ad_proc
@param docblock the documentation block, is passed to ad_proc
@param body the body, is passed to ad_proc
-
- Defines a method for type based dispatch. This method can be
- called using ad_call_method
. The first arg to the
- method is the target on which the type dispatch happens. Use this
- with care.
} {
ad_proc ${method_name}__$type $argblock $docblock $body
}
@@ -501,15 +508,15 @@
object_id
args
} {
- @param method_name method name
- @param object_id the target, it is the first arg to the method
- @param args the remaining arguments
-
Calls method_name for the type of object_id with object_id as the
first arg, and the remaining args are the remainder of the args to
method_name. Example ad_call_method method1 foo bar baz calls the
the method1 associated with the type of foo, with foo bar and baz
as the 3 arguments.
+
+ @param method_name method name
+ @param object_id the target, it is the first arg to the method
+ @param args the remaining arguments
} {
return [apply ${method_name}__[util_memoize "acs_object_type $object_id"] [concat $object_id $args]]
}
@@ -519,15 +526,15 @@
type
args
} {
- @param method_name method name
- @param object_id the target, it is the first arg to the method
- @param args the remaining arguments
-
Calls method_name for the type of object_id with object_id as the
first arg, and the remaining args are the remainder of the args to
method_name. Example ad_call_method method1 foo bar baz calls the
the method1 associated with the type of foo, with foo bar and baz
as the 3 arguments.
+
+ @param method_name method name
+ @param object_id the target, it is the first arg to the method
+ @param args the remaining arguments
} {
return [apply ${method_name}__$type $args]
}
Index: openacs-4/packages/acs-tcl/tcl/defs-procs.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-tcl/tcl/defs-procs.tcl,v
diff -u -r1.15 -r1.16
--- openacs-4/packages/acs-tcl/tcl/defs-procs.tcl 10 Sep 2002 22:22:14 -0000 1.15
+++ openacs-4/packages/acs-tcl/tcl/defs-procs.tcl 13 Sep 2002 20:10:48 -0000 1.16
@@ -1,13 +1,17 @@
ad_library {
ACS-specific general utility routines.
+
@author Philip Greenspun (philg@arsdigita.com)
- @author Many others at ArsDigita and at the OpenACS community.
+
+ @author Many others at ArsDigita and in the OpenACS community.
@creation-date 2 April 1998
@cvs-id $Id$
}
ad_proc ad_acs_version {} {
- @return the OpenACS version of this instance.
+ The OpenACS version of this instance.
+
+ @return version string (major.minor.release)
} {
set release_tag {}
regexp "acs-(\[0-9\]+)-(\[0-9\]+)-(\[0-9\]+)" \
@@ -21,7 +25,9 @@
}
ad_proc ad_acs_release_date {} {
- @return The OpenACS release date of this instance.
+ The OpenACS release date of this instance.
+
+ @return pretty version of the release date
} {
set release_tag {}
regexp "R(\[0-9\]+)" $release_tag match release_date
@@ -38,6 +44,7 @@
ad_proc ad_host_administrator {} {
As defined in the HostAdministrator kernel parameter.
+
@return The e-mail address of a technical person who can fix problems
} {
return [ad_parameter -package_id [ad_acs_kernel_id] HostAdministrator]
@@ -634,7 +641,7 @@
parameter on server startup or access an arbitrary parameter (e.g., you are writing bboard code, but
want to know an acs-kernel parameter), specifiy the package_id parameter to the object id of the package
you want.
-
+
Note: The parameters/ad.ini file is deprecated. @see parameter::set_value