Version 1.0.1 (22 March 2021)

New Features

  • hdoc is now open source and provides free hosting! See the blog post for details.

Fixes

  • hdoc's documentation websites now indicates there were no {Enums,Namespaces,Records} in a project instead of just printing a blank page
  • "Defined at" text was replaced with "Declared at" on HTML pages

Version 1.0.0 (4 February 2021)

New Features

  • User documentation is now hosted at docs.hdoc.io.
    • Users must supply the HDOC_PROJECT_API_KEY environment variable when running hdoc. The API key is generated when a new project is created in the hdoc console.
    • Documentation is hosted behind a CDN for maximum performance.
    • Enterprise Edition retains the option to output documentation to HTML files on the local filesystem.
  • hdoc now uses multiple threads to increase the speed at which it analyzes projects.
    • The num_threads option in .hdoc.toml controls the number of threads to be used. See the configuration file reference for more information.
    • By default all available threads will be used, corresponding to num_threads = 0.
    • Processing speed increase is roughly linear with number of threads, which significantly improves performance on large projects.
  • Attribution for open source projects.
    • hdoc relies on several open source projects, and now shows attribution for these projects.
    • Passing the --oss flag on the command line will print attribution information.
    • This information is also available on the hdoc.io website.
    • To the maintainers and contributors to these projects: thank you!
  • [Enterprise Edition] Full support for browsing local documentation using file:/// URLS.
    • Local HTML output is now fully static and does not require a local HTTP server for most browsing.
    • However, using search functionality still requires a HTTP server.

Fixes

  • Minor whitespace fixes.
    • Several minor fixes to extraneous whitespace that was inserted into the HTML documentation in corner cases.
  • It is more accurate to refer to Structs, Classes, and Unions as "Records" instead of using the catch all term "Classes".
    • All references to "Classes" except those that are actually class declarations have been renamed to "Records".
  • Explicit handling of scoped enums.
    • Scoped enums, or enum class, were listed as C-style enums. This has been fixed and they are now referred to by the correct name: enum class.

Alpha (17 July 2020)

Initial release.