acs-api-documentation-procs.tcl

  • last updated 8 hours ago
Constraints
Constraints: committers
 
Constraints: files
Constraints: dates
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
improve log messages

  1. … 1 more file in changeset.
Fix typo

whitespace changes

  1. … 1 more file in changeset.
improve robustness of API browser when trying to browse non-existing objects

  1. … 1 more file in changeset.
remove comma before that

  1. … 1 more file in changeset.
whitespace changes

improve behavior, in case dot leads to an error.

don't confuse nodes, when test cases have the exact same names as functions

    • -17
    • +21
    ./acs-api-documentation-procs.tcl
tclcode_to_html: Don't render "?" as a command

make api_get_body more robust: when name contains wild-card characters, escape name for such commands accordingly

strip out empty query parameter

  1. … 2 more files in changeset.
turn procs into private ad_procs with doc-strings

    • -19
    • +26
    ./acs-api-documentation-procs.tcl
Fix typos

  1. … 3 more files in changeset.