Version 0.9.1 (2024-12-23)

• Fix generated timestamp in docs
  • This timestamp slipped in with the last release
  • Make it an option restores the previous behaviour
  • It is a bad idea to have always changing docs without code changes

Version 0.9.0 (2024-12-22)

• Fix parsing issue for complex objects (thanks to github.com/gpaulissen for providing feedback and a test object)
• Non existing folders for generated docs will be created automatically (thanks to github.com/erstert3st for the pull request)
• New option to print the ploc version (thanks to github.com/erstert3st for the pull request)
• Update dependencies

Feature Release

• New parameter: --autoHeaderIds
  • Boolean - if present the headers are generated in HTML format instead of
    Markdown to be able to integrate the IDs
  • Header IDs came in the past with the TOC implicitly (until the last release,
    where I dropped this) - now you have the choice with a parameter

Feature Release

• New parameter: --tocStyles to provide inline styles to use for the TOC
  • If provided, the TOC is generated as a HTML unordered list instead of a Markdown list to be able to use the styles.
  • Example npx ploc --in "src/*.pks" --out docs/{file}.md --tocStyles "float: right;"

Bugfix Release

• Fixed: TOC links only working with generated HTML header IDs
• Fixed: TOC Links to overloaded functions and procedures are not working
• Use pure Markdown for the headers since many Markdown processors automatically generate header IDs - for example in VS Code it is working out of the box and GitHub does it also

Bugfix Release

• Fixed: Add a markdownlint configuration on top of each generated file to get no warnings for rules MD003, MD012, MD033 (also see issue #5)

Bugfix Release

• Fixed: Escaped SQL*Plus special characters are now replaced globally in a doc comment

Feature Release

• Improved generated document structure
  • A leading level one header in the first comment (usually the package description) is used as the overall document header
  • An eventually rendered TOC is following this overall header
• PLOC does now unescape escaped special SQL*Plus characters (see section "SQL*Plus Special Characters")
• Change minimum number of items to render a TOC from 4 to 3

Feature Release

• Add "Do not edit..." message to generated files
• Add debug param to CLI for parsed arguments
• Improved README regarding glob patterns
• Internal renamings

Bugfix Release

• Fixed: parsing regex breaks when keywords package, function, procedure, trigger or type found in a signature (not the starting one, sure, but in a line comment or type declaration)
  • example with two problems: demo_param my_table.my_column%TYPE --A cool function param
• New (manual) test script