Skip to content

doc, tools: make type parsing more strict

Rodrigo Muino Tomonari requested to merge github/fork/vsemozhetbyt/tools-doc-strict-types into master
Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

We do many small correction PRs for doc types format. This change makes type parsing more strict to avoid these post-corrections. Wrong or undefined types would throw on doc build stage.

Main code changes:

  • Make type check case-sensitive (no more uppercased primitives, lowercased global objects etc).
  • Make any type linkable (to this section).
  • Throw on any unrecognized type.

New parsing mode had detected some issues which have been fixed.

  • Fix miscased unlinkable types like {object} here.
  • Add missing type definitions for unlinkable types like {Cipher} here.
  • Fix undefined type synonyms in docs.
  • Replace non-JavaScript types with verbatim HTML fragments to be consistent in CSS style: only one place here.
  • Change type false-positive format here — notice the bizarre heading rendering and #hash URL part.

Also, some style nits in tools/doc/type-parser.js were fixed.

Merge request reports