acs-api-documentation-procs.tcl

  • last updated 7 hours ago
Constraints
Constraints: committers
 
Constraints: files
Constraints: dates
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.
beautify labels of ensemble methods in object browser

added support for NX ensemble methods

  1. … 2 more files in changeset.
improve spelling

  1. … 42 more files in changeset.
make tcl_to_html public

Added support for trailing non-positional arguments

The change makes the old hack with the own trailing-argument-parser

"ad_arg_parser" obsolete by using directly the c-level argument parser

which is anyhow capable of handling trailing arguments. A few changes

were necessary for api doc to handle there trailing arguments as well.

The proc "db_string" is already converted to use native arguments.

    • -27
    • +39
    ./acs-api-documentation-procs.tcl
  1. … 7 more files in changeset.
make clear from the name that db_qd_prepare_queryfile_content is intended to be used in different packages

  1. … 2 more files in changeset.
added "content_type" to the list of specially handled calls. this fixes two more cases in Test case callgraph__bad_calls

- fixed mis-classification of "max", "min" and "random" in "tclcode_to_html"

- added new test case "callgraph__bad_calls" to check for

a) calls to deprecated procs

b) direct calls to private procs from other packages ("private" means "packakge private"

    • -11
    • +29
    ./acs-api-documentation-procs.tcl
  1. … 1 more file in changeset.
make end of options explicit

  1. … 42 more files in changeset.
Prefer 'namespace which' over 'info commands', as it is faster (on local tests, around 2x) and returns a single value. Many thanks to Nathan Coulter.

    • -18
    • +21
    ./acs-api-documentation-procs.tcl
  1. … 58 more files in changeset.
Fix typo in proc doc

Add 'case' to the list of Tcl keywords. The command is obsolete, deprecated, not documented anymore and slated for removal in Tcl 9.0, but still exists and makes the api_doc confused and unhappy.

Avoid looking for proc names in comments after a semicolon or an opening curly brace, so common words in comments are not included in the api-doc as calls to procs with the same name

Add 'exit' to the list of Tcl keywords, so it is properly managed by the api-doc logic

Add 'unknown' to the list of Tcl keywords, so it is properly managed by the api-doc logic

Include '-' as a valid character in a proc name in acs-api-browser's 'length_proc'. Fixes the 'acs_api_browser_apidoc_tclcode_to_html' test case.

fix for issue #3427

new funcion: util::inline_svg_from_dot: refactored version from private api-procs function.

use new function in api-doc

CVS: ----------------------------------------------------------------------

    • -56
    • +10
    ./acs-api-documentation-procs.tcl
  1. … 3 more files in changeset.
Allow dots in the proc name when building the doc HTML to accomodate e.g. for procs such as "system.methodHelp"