Index: openacs-4/packages/acs-api-browser/tcl/acs-api-documentation-procs.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-api-browser/tcl/acs-api-documentation-procs.tcl,v
diff -u -N -r1.72.2.41 -r1.72.2.42
--- openacs-4/packages/acs-api-browser/tcl/acs-api-documentation-procs.tcl 26 Jun 2022 15:19:54 -0000 1.72.2.41
+++ openacs-4/packages/acs-api-browser/tcl/acs-api-documentation-procs.tcl 23 Aug 2022 12:58:19 -0000 1.72.2.42
@@ -212,7 +212,7 @@
# array set as_default_value $doc_elements(as_default_value)
# if { [llength $doc_elements(as_arg_names)] > 0 } {
- # append out "
Query Parameters:\n"
+ # append out "Query Parameters:\n"
# foreach arg_name $doc_elements(as_arg_names) {
# append out "$arg_name"
# set notes [list]
@@ -235,11 +235,11 @@
# append out "\n"
# }
# if { [info exists doc_elements(type)] && $doc_elements(type) ne "" } {
- # append out "Returns Type:$doc_elements(type)\n"
+ # append out "Returns Type:$doc_elements(type)\n"
# }
# # XXX: Need to support "Returns Properties:"
# }
- append out "Location:$path\n"
+ append out "Location:$path\n"
append out [::apidoc::format_common_elements doc_elements]
append out ""
@@ -270,19 +270,19 @@
append out [lindex $doc_elements(main) 0]
append out "\n"
- append out "- Location:\n
- [ns_quotehtml $path]\n"
+ append out "
- Location:
\n- [ns_quotehtml $path]\n"
if { [info exists doc_elements(creation-date)] } {
- append out "
- Created:\n
- [lindex $doc_elements(creation-date) 0]\n"
+ append out "
- Created:
\n- [lindex $doc_elements(creation-date) 0]\n"
}
if { [info exists doc_elements(author)] } {
- append out "
- Author[expr {[llength $doc_elements(author)] > 1 ? "s" : ""}]:\n"
+ append out "
- Author[expr {[llength $doc_elements(author)] > 1 ? "s" : ""}]:
\n"
foreach author $doc_elements(author) {
append out " - [::apidoc::format_author $author]\n"
}
}
if { [info exists doc_elements(cvs-id)] } {
append out [subst {
-
- CVS Identification:
+
- CVS Identification:
[ns_quotehtml [lindex $doc_elements(cvs-id) 0]]
}]
}
@@ -354,7 +354,7 @@
append out \
[::apidoc::format_common_elements doc_elements] \
- "- Location:
- $doc_elements(script)\n" \
+ "
- Location:
- $doc_elements(script)\n" \
"
\n"
return $out
@@ -545,9 +545,9 @@
set switches [concat $doc_elements(switches0) $doc_elements(switches1)]
if { [llength $switches] > 0 } {
- append blocks_out "Switches:\n"
+ append blocks_out "- Switches:
\n"
foreach switch $switches {
- append blocks_out "- -$switch"
+ append blocks_out "
- -$switch
"
if {"boolean" in $flags($switch)} {
append blocks_out " (boolean)"
}
@@ -572,7 +572,7 @@
}
if { [llength $doc_elements(positionals)] > 0 } {
- append blocks_out "- Parameters:
- \n"
+ append blocks_out "
- Parameters:
- \n"
foreach positional $doc_elements(positionals) {
append blocks_out "$positional"
if { [info exists default_values($positional)] } {
@@ -600,19 +600,19 @@
append blocks_out "Options:
"
foreach param $doc_elements(option) {
if { [regexp {^([^ \t]+)[ \t](.+)$} $param "" name value] } {
- append blocks_out "- -$name
- $value
"
+ append blocks_out "- -$name
- $value
"
}
}
append blocks_out "
"
}
if { [info exists doc_elements(return)] } {
- append blocks_out " - Returns:
- [join $doc_elements(return) "
"] \n"
+ append blocks_out "- Returns:
- [join $doc_elements(return) "
"] \n"
}
if { [info exists doc_elements(error)] } {
- append blocks_out "- Error:
- [join $doc_elements(error) "
"] \n"
+ append blocks_out "- Error:
- [join $doc_elements(error) "
"] \n"
}
append blocks_out [::apidoc::format_common_elements doc_elements]
@@ -627,10 +627,10 @@
set callgraph [util::inline_svg_from_dot -css $css \
[api_call_graph_snippet -proc_name $proc_name -maxnodes 5]]
if {$callgraph ne ""} {
- append blocks_out "- Partial Call Graph (max 5 caller/called nodes):
- $callgraph
\n"
+ append blocks_out "- Partial Call Graph (max 5 caller/called nodes):
- $callgraph
\n"
}
- append blocks_out "- Testcases:
- \n"
+ append blocks_out "
- Testcases:
- \n"
if {[info exists doc_elements(testcase)]} {
set cases {}
@@ -650,12 +650,12 @@
-package_key acs-api-browser \
-parameter FancySourceFormattingP \
-default 1]} {
- set source_out [subst {
- Source code:
-
+ set source_out [subst {
- Source code:
-
[::apidoc::tcl_to_html $proc_name]
}]
} else {
- set source_out [subst {- Source code:
-
+ set source_out [subst {
- Source code:
-
[ns_quotehtml [api_get_body $proc_name]]
}]
@@ -673,7 +673,7 @@
if { [file exists $::acs::rootdir/$xql_fn] } {
set content [apidoc::get_xql_snippet -proc_name $proc_name -xql_file $xql_fn]
if {$content ne ""} {set content "$content
"}
- append there [subst {- Generic XQL file:
+ append there [subst {- Generic XQL file:
- $content
$xql_fn
@@ -688,7 +688,7 @@
set content [apidoc::get_xql_snippet -proc_name $proc_name -xql_file $xql_fn]
if {$content ne ""} {set content "
$content
"}
set href [export_vars -base content-page-view {{source_p 1} {path $xql_fn}}]
- append there [subst { - PostgreSQL XQL file:
+ append there [subst {- PostgreSQL XQL file:
- $content
$xql_fn
@@ -703,7 +703,7 @@
set content [apidoc::get_xql_snippet -proc_name $proc_name -xql_file $xql_fn]
if {$content ne ""} {set content "
$content
"}
set href [export_vars -base content-page-view {{source_p 1} {path $xql_fn}}]
- append there [subst { - Oracle XQL file:
+ append there [subst {- Oracle XQL file:
- $content
$xql_fn
@@ -713,7 +713,7 @@
lappend missing Oracle
}
if {[llength $missing] > 0} {
- set xql_out [subst {
- XQL Not present:
- [join $missing ", "]
}]
+ set xql_out [subst {- XQL Not present:
- [join $missing ", "]
}]
}
append xql_out $there
} else {
@@ -1319,7 +1319,7 @@
ad_proc -private format_changelog_list { changelog } {
Format the change log info
} {
- append out "- Changelog:\n"
+ append out "
- Changelog:
\n"
foreach change $changelog {
append out " - [format_changelog_change $change]
\n"
}
@@ -1346,7 +1346,7 @@
if { [llength $authors] == 0 } {
return ""
}
- append out "- Author[expr {[llength $authors] > 1 ? "s" : ""}]:\n"
+ append out "
- Author[expr {[llength $authors] > 1 ? "s" : ""}]:
\n"
foreach author $authors {
append out " - [format_author $author]
\n"
}
@@ -1362,13 +1362,13 @@
append out [format_author_list $doc_elements(author)]
}
if { [info exists doc_elements(creation-date)] } {
- append out "- Created:\n
- [lindex $doc_elements(creation-date) 0]
\n"
+ append out "- Created:
\n- [lindex $doc_elements(creation-date) 0]
\n"
}
if { [info exists doc_elements(change-log)] } {
append out [format_changelog_list $doc_elements(change-log)]
}
if { [info exists doc_elements(cvs-id)] } {
- append out "- CVS ID:\n
[ns_quotehtml [lindex $doc_elements(cvs-id) 0]]
\n"
+ append out "- CVS ID:
\n[ns_quotehtml [lindex $doc_elements(cvs-id) 0]]
\n"
}
if { [info exists doc_elements(see)] } {
append out [format_see_list $doc_elements(see)]
@@ -1380,11 +1380,11 @@
ad_proc -private format_see_list { sees } {
Generate an HTML list of referenced procs and pages.
} {
- append out "
See Also:\n"
+ append out "- See Also:
\n"
foreach see $sees {
append out "- [format_see $see]\n"
}
- append out "
\n"
+ append out "
\n"
return $out
}