Index: openacs-4/contrib/packages/bcms/tcl/bcms-category-procs.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/contrib/packages/bcms/tcl/bcms-category-procs.tcl,v
diff -u -r1.7 -r1.8
--- openacs-4/contrib/packages/bcms/tcl/bcms-category-procs.tcl 13 Nov 2003 14:24:38 -0000 1.7
+++ openacs-4/contrib/packages/bcms/tcl/bcms-category-procs.tcl 17 Feb 2004 14:38:24 -0000 1.8
@@ -79,7 +79,7 @@
@param category_id The category id of the category to get the data
- @returns an array with the following properties:
+ @return an array with the following properties:
category_id, parent_id, heading, description, has_children
} {
@@ -107,7 +107,7 @@
@param return_list if supplied a list of ns_sets otherwise it
returns a multirow uses the multirow_name if given
- @returns makes a multirow of categories or list of ns sets with the following properties:
+ @return makes a multirow of categories or list of ns sets with the following properties:
category_id, parent_id, heading, description, has_children
} {
@@ -142,7 +142,7 @@
@param return_list if supplied a list of ns_sets otherwise it
returns a multirow uses the multirow_name if given
- @returns all sub categories under the root_id with the following attributes:
+ @return all sub categories under the root_id with the following attributes:
category_id, parent_id, heading, description, has_children, path
} {
@@ -174,7 +174,7 @@
@param return_list if supplied a list of ns_sets otherwise it
returns a multirow uses the multirow_name if given
- @returns a multirow/list with the following elements:
+ @return a multirow/list with the following elements:
category_id, path, heading
} {
@@ -203,7 +203,7 @@
@param category_id a node of the category tree
- @returns an array with the following properties:
+ @return an array with the following properties:
category_id, parent_id, heading, description, has_children
} {
Index: openacs-4/contrib/packages/bcms/tcl/bcms-folder-procs.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/contrib/packages/bcms/tcl/bcms-folder-procs.tcl,v
diff -u -r1.13 -r1.14
--- openacs-4/contrib/packages/bcms/tcl/bcms-folder-procs.tcl 9 Feb 2004 14:29:20 -0000 1.13
+++ openacs-4/contrib/packages/bcms/tcl/bcms-folder-procs.tcl 17 Feb 2004 14:38:24 -0000 1.14
@@ -283,7 +283,7 @@
@param folder_id id of the folder to check
@param content_type content type to check if its registered on not
- @returns 1 if its registered if not 0
+ @return 1 if its registered if not 0
} {
set result [db_exec_plsql check_content_type {}]
if {$result == "t"} {
Index: openacs-4/contrib/packages/bcms/tcl/bcms-item-procs.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/contrib/packages/bcms/tcl/bcms-item-procs.tcl,v
diff -u -r1.15 -r1.16
--- openacs-4/contrib/packages/bcms/tcl/bcms-item-procs.tcl 9 Feb 2004 14:42:28 -0000 1.15
+++ openacs-4/contrib/packages/bcms/tcl/bcms-item-procs.tcl 17 Feb 2004 14:38:24 -0000 1.16
@@ -18,7 +18,7 @@
@param item_id you wish to know what content type
- @returns the content type of an item
+ @return the content type of an item
} {
array set one_item [get_item -item_id $item_id]
return $one_item(content_type)
@@ -46,7 +46,7 @@
@param creation_user user_id creating this item
@param creation_ip ip address which this item is created
- @returns the item_id that was created
+ @return the item_id that was created
} {
if {![info exists creation_user]} { set creation_user [ad_conn user_id] }
if {![info exists creation_ip]} { set creation_ip [ad_conn peeraddr] }
@@ -73,7 +73,7 @@
@param creation_user user_id creating this item
@param creation_ip ip address which this item is created
- @returns the item_id of the new link
+ @return the item_id of the new link
} {
if {![info exists creation_user]} { set creation_user [ad_conn user_id] }
if {![info exists creation_ip]} { set creation_ip [ad_conn peeraddr] }
@@ -114,7 +114,7 @@
@param item_id of the item to be deleted
- @returns 0 if successful.
+ @return 0 if successful.
} {
return [db_exec_plsql delete_item {}]
}
@@ -138,7 +138,7 @@
@param show_only ids of the item to show only, normally this used in conjuction with
list builder and paginator
- @returns rows of content items below the parent_id
+ @return rows of content items below the parent_id
with the following columns:
item_id, name, live_revision, latest_revision, publish_status,
@@ -296,7 +296,7 @@
@param revision will only returns items that have live or latest revision under the parent_id
if this is used additional info are returned such as revision_id, title, description, publish_date
- @returns the following columns
+ @return the following columns
item_id, name, live_revision, latest_revision, publish_status,
content_type, storage_type, rel_id, order_n, path
@@ -353,7 +353,7 @@
@param resolve_index return the item_id of the index content item on a content_folder
rather than the content_folder's item_id
- @returns the item_id of the item from that URL, or the empty string if no such item exists.
+ @return the item_id of the item from that URL, or the empty string if no such item exists.
} {
set resolve_index [db_boolean $resolve_index_p]
return [db_exec_plsql get_item_id {}]
@@ -376,7 +376,7 @@
@param resolve_index return the item_id of the index content item on a content_folder
rather than the content_folder's item_id
- @returns an array that contains the following
+ @return an array that contains the following
item_id, name, parent_id, live_revision, latest_revision, publish_status, content_type
and storage_type
@@ -423,7 +423,7 @@
@param revision if "-revision live" or "-revision lastest" is given then additional
properties are returned
- @returns an array that contains the following
+ @return an array that contains the following
item_id, name, parent_id, live_revision, latest_revision, publish_status, content_type,
storage_type
@@ -491,7 +491,7 @@
@param order_n order of the relation, you can have 1 to many relation. the order of this relation.
@param relation_type LARS HELP NEEDED
- @returns LARS HELP NEEDED
+ @return LARS HELP NEEDED
} {
return [db_exec_plsql relate_item {}]
@@ -538,7 +538,7 @@
@param string the string to format
@param truncate if the string is long truncate at what point
- @returns the url friendly transformed string
+ @return the url friendly transformed string
} {
set string [string trim $string]
regsub -all " " $string "" string
@@ -585,7 +585,7 @@
@param root_id start the checking from which root_id/folder_id
@param count pad a number up to how many times if there is a duplicate
- @returns a none duplicate url
+ @return a none duplicate url
} {
set url [bcms::item::format_string_as_url -string $url]
@@ -622,7 +622,7 @@
returns a multirow uses the multirow_name if given
@param no_parent does not return additional rows containing the parents to this item
- @returns a multirow/list with following elements item_id, path, title
+ @return a multirow/list with following elements item_id, path, title
} {
if ![info exists root_id] {
# if the parent_id does not exists then start from the root
@@ -690,7 +690,7 @@
@param item_id id of the item
- @returns category ids assigned to this item
+ @return category ids assigned to this item
} {
return [db_list get_categories {}]
Index: openacs-4/contrib/packages/bcms/tcl/bcms-procs.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/contrib/packages/bcms/tcl/bcms-procs.tcl,v
diff -u -r1.9 -r1.10
--- openacs-4/contrib/packages/bcms/tcl/bcms-procs.tcl 9 Feb 2004 14:45:28 -0000 1.9
+++ openacs-4/contrib/packages/bcms/tcl/bcms-procs.tcl 17 Feb 2004 14:38:25 -0000 1.10
@@ -15,15 +15,15 @@
} {
@param object_type the object_type of an object, normally the content_type since we are dealing with cms
- @returns the table name of a particular object_type
+ @return the table name of a particular object_type
} {
return [db_string get_table_name {}]
}
# for possible contribution
ad_proc -public bcms::get_next_objectid { } {
- @returns the next acs objectID sequence from the database
+ @return the next acs objectID sequence from the database
} {
return [db_string get_next_objectid {}]
}
@@ -51,7 +51,7 @@
@param creation_user user_id creating this page
@param creation_ip ip address which this page is created
- @returns the page_id of the newly created page
+ @return the page_id of the newly created page
} {
if {![info exists creation_user]} { set creation_user [ad_conn user_id] }
if {![info exists creation_ip]} { set creation_ip [ad_conn peeraddr] }
@@ -91,7 +91,7 @@
@param creation_user user_id creating this page
@param creation_ip ip address which this page is created
- @returns the file_id of the newly created file
+ @return the file_id of the newly created file
} {
# we need to check for an existing conn before doing this in tcl
# probably better to just set them to NULL
Index: openacs-4/contrib/packages/bcms/tcl/bcms-revision-procs.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/contrib/packages/bcms/tcl/bcms-revision-procs.tcl,v
diff -u -r1.18 -r1.19
--- openacs-4/contrib/packages/bcms/tcl/bcms-revision-procs.tcl 10 Feb 2004 16:03:52 -0000 1.18
+++ openacs-4/contrib/packages/bcms/tcl/bcms-revision-procs.tcl 17 Feb 2004 14:38:25 -0000 1.19
@@ -39,7 +39,7 @@
{property:noquote value} will directly use what is in value.
Use [list [list prop1 $val1] [list $prop2 $val2]] to generate.
- @returns revision_id of newly created revision
+ @return revision_id of newly created revision
} {
if { [exists_and_not_null additional_properties] } {
@@ -101,6 +101,7 @@
# get the file properties
set upload_filename [template::util::file::get_property filename $upload_file]
set upload_tmpfile [template::util::file::get_property tmp_filename $upload_file]
+
if { ![exists_and_not_null mime_type] } {
set mime_type [template::util::file::get_property mime_type $upload_file]
}
@@ -144,7 +145,7 @@
@param return_list if supplied a list of ns_sets otherwise it
returns a multirow uses the multirow_name if given
- @returns the revisions of a content item. with the following data:
+ @return the revisions of a content item. with the following data:
revision_id, title, live_revision_id, creation_date, description and creation user's first_names and last_name
} {
# TODO: content_type is passed not sure if if need to,
@@ -165,12 +166,12 @@
{-revision_id:required}
{-additional_properties}
} {
- Get the revision info on a single revision
+ Get the revision info on a single revision in array-list format.
@param revision_id revision_id of the version you want to retrieve
@param additional_properties a list of property names that you add to the array returned
- @returns an array that contains item_id, name, title, description,
+ @return an array that contains item_id, name, title, description,
content, content_type, publish_status, latest_revision, live_revision, storage_type
and whatever additional_properties is supplied
} {
@@ -271,7 +272,7 @@
@param revision_id id of the revision to delete
- @returns 1 if the deletion is successful, 0 if not.
+ @return 1 if the deletion is successful, 0 if not.
} {
set revision_count [db_string get_revision_count {}]
if {$revision_count > 1} {
@@ -318,7 +319,7 @@
@param creation_user user performing the copy
@param creation_ip ip address of the user performing the copy
- @returns the version id of the new revision
+ @return the version id of the new revision
} {
if {![info exists creation_user_id]} { set creation_user_id [ad_conn user_id] }
Index: openacs-4/contrib/packages/bcms/tcl/bcms-template-procs.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/contrib/packages/bcms/tcl/bcms-template-procs.tcl,v
diff -u -r1.5 -r1.6
--- openacs-4/contrib/packages/bcms/tcl/bcms-template-procs.tcl 9 Feb 2004 14:50:08 -0000 1.5
+++ openacs-4/contrib/packages/bcms/tcl/bcms-template-procs.tcl 17 Feb 2004 14:38:25 -0000 1.6
@@ -19,7 +19,7 @@
@param creation_user_id user_id creating this item
@param creation_user_ip ip address which this item is created
- @returns the item_id of the new template
+ @return the item_id of the new template
} {
if {![info exists creation_user_id]} { set creation_user_id [ad_conn user_id] }
if {![info exists creation_ip]} { set creation_ip [ad_conn peeraddr] }
@@ -45,7 +45,7 @@
@param creation_user_id user_id creating this item
@param creation_ip ip address which this item is created
- @returns the revision_id of the new template revision
+ @return the revision_id of the new template revision
} {
if {![info exists creation_user_id]} { set creation_user_id [ad_conn user_id] }
@@ -69,7 +69,7 @@
@param return_list if supplied a list of ns_sets otherwise it
returns a multirow uses the multirow_name if given
- @returns rows of content items below the parent_id
+ @return rows of content items below the parent_id
with the following columns:
template_id, name, live_revision, latest_revision, publish_status, content_type, storage_type, tree_sortkey,
@@ -110,7 +110,7 @@
ad_proc -public bcms::template::get_cr_root_template_folder {} {
gets the folder_id of the template root of cr
- @returns the folder id of the root CR template
+ @return the folder id of the root CR template
} {
set template_root [db_exec_plsql get_template_root {}]
return $template_root
@@ -179,7 +179,7 @@
@param item_id item you want to get a template
@param context the context of the template
- @returns an array that contains properties of the template, if no
+ @return an array that contains properties of the template, if no
template is found it returns a blank array.
} {
if ![info exists context] {
Index: openacs-4/contrib/packages/bcms/tcl/bcms-widget-procs.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/contrib/packages/bcms/tcl/bcms-widget-procs.tcl,v
diff -u -r1.10 -r1.11
--- openacs-4/contrib/packages/bcms/tcl/bcms-widget-procs.tcl 9 Feb 2004 14:51:27 -0000 1.10
+++ openacs-4/contrib/packages/bcms/tcl/bcms-widget-procs.tcl 17 Feb 2004 14:38:25 -0000 1.11
@@ -177,7 +177,7 @@
@param category_id id of which item to get a context
@param root_id start from which id
- @returns a list in {{url label} {url label}} format
+ @return a list in {{url label} {url label}} format
} {
if {[empty_string_p $root_url]} {
set root_url [ad_conn package_url]