Hawkmoth

------------------

:Date: 2023-03-21

Added
~~~~~

* Early support for documenting C++ (contributions courtesy of `Critical Software`_)
* Support for extending documentation comment parsing and transformations via
``hawkmoth-process-docstring`` event
* ``hawkmoth_transform_default`` configuration option for the
``hawkmoth-process-docstring`` event
* ``hawkmoth_root`` configuration option to replace ``cautodoc_root``
* ``hawkmoth_clang`` configuration option to replace ``cautodoc_clang``
* Built-in extensions for Javadoc and Napoleon comment handling

.. _Critical Software: https://www.criticalsoftware.com/

Changed
~~~~~~~

* Typedefed anonymous struct, union, and enum parsing to be more explicit
* ``cautodoc_transformations`` handling moved to a built-in extension
* Lots of test suite refactoring and cleanups

Deprecated
~~~~~~~~~~

* ``cautodoc_root`` configuration option in favour of ``hawkmoth_root``
* ``cautodoc_clang`` configuration option in favour of ``hawkmoth_clang``

Removed
~~~~~~~

* ``cautodoc_compat`` configuration option
* ``compat`` directive option

------------------

:Date: 2022-12-13

Added
~~~~~

* Parsing for function pointer argument names
* Guide to contributing
* Troubleshooting documentation
* Install 'hawkmoth' command-line tool for debugging
* GitHub CI automation
* Overview documentation for the tests

Changed
~~~~~~~

* Log Clang and parser warnings at default Sphinx verbosity level
* Bumped Docker container Sphinx version to 5.3.0
* Cleaned up examples section of the documentation

Fixed
~~~~~

* Fix whitespace in the output
* Fix function definitions with void parameter list as opposed to empty
* Fix parser warnings on documentation comments in unexpected locations
* Fix Clang warnings from examples in 'make html'

------------------

:Date: 2022-04-03

Fixed
~~~~~

* Fix handling of anonymous enums, structs and unions for Clang 13
* Fix handling of arrays of pointers

------------------

:Date: 2021-10-30

Changed
~~~~~~~

* More internal testing refactoring
* Use flake8 to enforce style

Fixed
~~~~~

* Fix handling of anonymous enums, structs and unions

-----------------

:Date: 2021-09-30

Added
~~~~~

* New fine-grained documentation directives ``c:autovar``, ``c:autotype``,
``c:automacro``, ``c:autofunction``, ``c:autostruct``, ``c:autounion``, and
``c:autoenum``
* Dockerfiles for Docker Hub container images

Changed
~~~~~~~

* Major internal implementation and testing refactoring
* IRC channel moved to OFTC IRC network

Fixed
~~~~~

* Documentation comment line prefix/indent removal (64)
* Hawkmoth documentation on Read the Docs

-----------------

:Date: 2021-05-21

Added
~~~~~

* Helper for discovering and configuring system include path
* Transform functionality for comment conversion

Changed
~~~~~~~

* Extension ``cautodoc_clang`` configuration option must now be a Python list
* Directive ``clang`` option now extends instead of overrides ``cautodoc_clang``
* Bumped Python dependency requirement to v3.6 for f-strings
* Switched to pytest for testing
* Switched to static packaging metadata
* Deprecated compat functionality in favour of transformations

Fixed
~~~~~

* Array function parameter documentation
* Function pointers with qualifiers such as const