api_proc_pretty_param_details (private)

 api_proc_pretty_param_details -flags flags \
    [ -default_value default_value ]

Defined in packages/acs-api-browser/tcl/acs-api-documentation-procs.tcl

Switches:

-flags (required)

-default_value (optional)

Returns:

string with details about a parameter

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Source code:

    set param_details {}
    if {"required" in $flags} {
        lappend param_details required
    } else {
        lappend param_details optional
    }
    if {"boolean" in $flags} {
        lappend param_details boolean
    } elseif {"int" in $flags || "integer" in $flags} {
        lappend param_details integer
    } elseif {"object" in $flags} {
        lappend param_details object
    }
    if {"0..1" in $flags} {
        lappend param_details "accept empty"
    }

    if { [info exists default_value] && $default_value ne ""} {
        lappend param_details "defaults to <code>\"[ns_quotehtml $default_value]\"</code>"
    }
    return [expr {[llength $param_details]>0 ? "([join $param_details {, }])" : ""}]

XQL Not present:

Generic, PostgreSQL, Oracle