acs-api-documentation-procs.tcl

  • last updated 12 hours ago
Constraints
Constraints: committers
 
Constraints: files
Constraints: dates
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"

Allow numbers in the first part of a proc name when counting its length in a way that apidoc::tclcode_to_html won't generate false positives when e.g. an XoTcl object called "9" exists and a word contains the character "9"

  1. … 1 more file in changeset.
New test for apidoc::format_see, fix doc according to its real behavior

  1. … 1 more file in changeset.
New test for apidoc::format_author, improve documentation

  1. … 1 more file in changeset.
Deprecate broken proc api_type_documentation and remove its leftover usages, in a script that is also broken

  1. … 3 more files in changeset.
Deprecated broken and unused api_proc_link

New test for api_proc_documentation, which brought to deprecation of the -format flag, because it has no effect

  1. … 1 more file in changeset.
fix lookup of links for external commands: avoid lookup of page-realtive links (starting with "#")

replace hardcoded /tmp by API function [ad_tmpdir]

  1. … 10 more files in changeset.
update predefined Tcl commands for pretty-printing Tcl code

include themed versions of files in the "variants" display (just for the current theme)

    • -14
    • +22
    ./acs-api-documentation-procs.tcl
change references from "http://*tcl.tk/" to "https://*tcl-lang.org/"

  1. … 5 more files in changeset.
improve spelling

  1. … 21 more files in changeset.
Replace ad_decode idiom

cache generated svg code on disk

    • -16
    • +30
    ./acs-api-documentation-procs.tcl