acs-api-documentation-procs.tcl

  • last updated 1 hour ago
Constraints
Constraints: committers
 
Constraints: files
Constraints: dates
Fixed runtime error, when "ns_cache" is viewed over the API browser

The problem was the method "flush", which is implemented via

alias to ::ns_cache__flush. In this case, "ns_cache info lookup syntax flush"

fails, because "info parameter" fails on the alias in command:

"::nsf::cmd::info parameter -context ::ns_cache ::ns_cache::flush"

  1. … 1 more file in changeset.
finetuning object descriptions

- adding links to per-object methods

- make sure that leading colons are used for object names in procdoc index

  1. … 1 more file in changeset.
moved xo::getObjectProperty to ::apidoc::get_object_property

    • -32
    • +187
    ./acs-api-documentation-procs.tcl
  1. … 9 more files in changeset.
fixed braces

Added listing of application specific methods to object viewer in api-doc/proc-view

This improves documentation of the caches via api-doc

  1. … 3 more files in changeset.
added support for @see pointing to objects

Improvded API browser documentation for NX methods

- Include NX content from acs* packages in online documentation

- determining source files where classes are defined

- extending type information for postional an non-positional arguments in API browser

  1. … 3 more files in changeset.
improved robustness (when fno flags for a parameter are present in the nsc)

provide more type information, factor out common code

    • -29
    • +44
    ./acs-api-documentation-procs.tcl
prettify rednderung for underspecified parameters

fixed broken HTML and make rendering more compact

ease future use of styling by introducing api-doc-parameter-list

    • -19
    • +25
    ./acs-api-documentation-procs.tcl
merge with missing files

  1. … 1464 more files in changeset.
merge from oacs-5-10

    • -182
    • +303
    ./acs-api-documentation-procs.tcl
  1. … 8099 more files in changeset.
Always use "--" in "dom parse" when document is interpolated

This is a safety measure to make sure that the document parsed is

never confused with an option, when the document starts with a "-". In

the best case, the error message provided by "dom parse" might be

misleading. This might be a problem for user contributed documents

(passed as variables, or return values from functions).

The double dash is supported in tdom since version 0.9.0.

  1. … 18 more files in changeset.
reduce verbosity

  1. … 2 more files in changeset.
improved Tcl9 compatibility

whitespace changes

    • -14
    • +14
    ./acs-api-documentation-procs.tcl
Fixed potential infinie loop when source code looks like an regexp call

The api-code prettifier contains several heuristics for prettifying

source code without being a proper parser. It contains a

"Hack for nasty regexp stuff" which could run potentially into an infinite

parsing loop. This change fixes an acutal bug on openacs.org for file [1]

which is site-local.

[1] https://openacs.org/api-doc/procs-file-view?path=packages/xowf/tcl/openacs-procs.tcl&version_id=5526548&source_p=1

fixed typo

  1. … 4 more files in changeset.
reduce verbosity

  1. … 4 more files in changeset.
Properly escape "<" and ">" in api-doc documentation.

Since all documentation is rendered via HTML, the characters

"<" and ">" have to be HTML-quoted, otherwise strange things

(omission, unintended renderings) might occur.

E.g. the sentence

Define an interface between a page and an

ADP <include> similar to the page_contract.

was rendered as

Define an interface between a page and an

ADP similar to the page_contract.

which is incorrect.

  1. … 13 more files in changeset.
improving rendering in api-doc

- fixed validity of HTML (missing <dd>)

- use

<dt>foo</dt><dd>...</dd>

instead of

<dt><b>foo></b><dd>...</dd>

and other variants. This improves stylability.

    • -29
    • +29
    ./acs-api-documentation-procs.tcl
  1. … 1 more file in changeset.
Fixed calling info in call-graph, marked verbose test as "stress"

  1. … 1 more file in changeset.
fix broken regression test

VS: ----------------------------------------------------------------------

- improved tab handling

- revive api_proc_link, paramertize it properly

Improve cmd detection semantics in "tclcode_to_html" to avoid

misintepretations from arguments lists. Make as well explicitly clear

that the results of the private function "api_called_proc_names" is

just based on heuristics, such it can only be used in cases, where

false positives do not matter.

remove indent as well on xotcl procs, handle also per-object methods the same way

    • -18
    • +18
    ./acs-api-documentation-procs.tcl
  1. … 1 more file in changeset.
added support for "ns_trim -prefix".

The command is predefined in NaviServer; if not available, a comatibility version is added.

This change also mitigates a potential memory-leak problem in nsv_dict with certain

versions of NaviServer which might lead on busy sites to problems.

  1. … 3 more files in changeset.
prettify API browser rendering for nx methods

- remove redundant doc block

- remove indentation

  1. … 1 more file in changeset.