Asciidoxy

=== Added

- [AD-59] Support for variables that are shared between included documents.

=== Changed

- Collisions between files in packages are now warnings by default. Use `--warnings-are-errors`
to change them back to errors. Collisions between files and directories are still fatal errors.

=== Fixed

- 27: `xml_subdir` and `include_subdir` should not be mandatory in the package specification if
packages with `contents.toml` are used.
- 28: {Cpp}: support `constexpr` functions and constructors.
- Changes to the insertion filter in included documents will no longer affect parent documents.
- Objective C: Do not append enclosing type to full name of nested types.
- Improve escaping of names in links.

=== Added

- Infrastructure for transcoding documentation from one to another language.
- Swift: [AD-28] Generating Swift documentation based on Objective C source code.
- Kotlin: [AD-27] Generating Kotlin documentation based on Java source code.
- [AD-15] Allow forcing to embed an included file in multipage mode.
- [AD-37] Show members for other visibility levels than public. By default only public and
protected members are shown. Use `filter` to change.
- [AD-32] New package format with contents metadata file. The contents file specifies whether the
package contains AsciiDoc includes or reference, and in what subdirectory. It can now also
include images that need to be included to the output.
- [AD-32] A directory containing images to include can be specified using `--image-dir`.
- [AD-11] The usage documentation has been separated into a getting started guide and reference
documentation.

=== Changed

- Argument `leveloffset` in `include` now supports `None` to prevent adding `leveloffset` in
the generated AsciiDoc.
- [AD-32] By default the directory containing the input file is not copied to the intermediate
build directory. Use `--base-dir` to enable copying of additional include files.
- [AD-32] `cross_document_ref` and `include` support a new `package_name` keyword to
point to files in packages. For new packages with a contents metadata file this keyword is
mandatory. If the package specifies a root document, the `filename` is optional now.
- [AD-32] For `cross_document_ref` the `anchor` and `link_text` arguments are now keyword
only. For backwards compatibility `api.cross_document_ref` is still supports the old syntax.
- [AD-32] For `include` the `leveloffset`, `link_text`, and `link_prefix` arguments are now
keyword only. For bacwards compatibility `api.include` still supports the old syntax.
- [AD-32] Multiple packages supplying the same file is now an error.
- [AD-54] If no `anchor` or `link_text` is given, the title of the document is used for the link
created by `cross_document_ref`. If the title cannot be read, the file name stem is used.
- [AD-54] If no `link_text` is given, the title of the document is used for the link created by
`include` in multipage mode. If the title cannot be read, the file name stem is used.
- [AD-42] The `api.` prefix for commands is no longer needed. It will be deprecated in a future
version. The `api.link_<kind>` and `api.insert_<kind>` commands are also deprecated and not
available without the `api.` prefix.

=== Fixed

- [AD-35] Improve handling of complex closures.
- Objective C: Support `__autoreleasing` suffix.
- Including files in parent directories no longer raises an exception.
- Files and directories provided on the command-line are validated before use.
- [AD-55] Insert anchors at the top of includes in singlepage mode to make cross document
references without anchors work.

=== Fixed

- [AD-33] Actually allow filtering of inner classes by visibility.
- [AD-46] Always fall back to original name if type parsing fails.
- [AD-48] Java: Support unmangled annotations.

=== Added

- {Cpp}: [AD-10] Support const methods.
- {Cpp}: Show destructors and operators for classes.
- [AD-8] Support default values for parameters.

=== Fixed

- {Cpp}: [AD-34] Hide default and deleted members.
- Correctly detect include file for free functions.
- [AD-33] Inner types can now be filtered by visibility (only public and protected for now).

=== Added

- [AD-18] Basic support for Java type annotations.
- Extend 'file_names' option for .toml files to support 'version' and 'name' interpolation.

=== Fixed

- Java constants are now described correctly.

=== Added

- [AD-4] Multi-page Table of Contents.

=== Changed

- [AD-1] Complete redesign of the type parser. The type parser is now token based instead of
using regular expressions.
- [AD-1] The new type parser is more strict and will issue warnings when a type is considered
malformed. These warnings will not trigger an error when `--warnings-are-errors` is enabled.
- [AD-2] Improve formatting of method parameters. Each parameter is put on its own line. The
first parameter is put on a separate line if the definition gets too long.
- [AD-3] Loading API reference using a package spec is no longer required. The `--spec-file`
option is no longer mandatory. This way you can generate any AsciiDoc file with python code,
without generating API reference documentation.
- [AD-5] When using `api.link` the first match from an overload set is returned, instead of
throwing an error. This can be disabled by using `allow_overloads=False`. `api.insert` still
requires a perfect match.
- [AD-29] Rename `multi_page` and `multi-page` to `multipage`. This is a breaking change for the
command-line options and `api.include`.

=== Fixed

- Issue 9 - std::function types with function arguments are now fully parsed.
- [AD-1] Many parsing issues for types have been addressed in the new type parser.