doxide

Modern documentation for modern C++. Configure with YAML, output Markdown, post-process with Material for MkDocs.

APACHE-2.0 License

Stars
51
doxide - Latest Release

Published by lawmurray 4 months ago

Fixes handling of indenting in comments for whitespace sensitive Markdown, e.g. nested lists, code blocks (#45).

doxide -

Published by lawmurray 7 months ago

  • Numerous fixes for Markdown formatting in conjunction with /// style documentation comments (#41)
doxide -

Published by lawmurray 9 months ago

  • Fixed parse error on standalone @ characters (without commands) #7.
doxide -

Published by lawmurray 9 months ago

  • Fix for multiline /// style documentation comments (#38).
doxide -

Published by lawmurray 9 months ago

  • Fixed member variables of pointer and reference type #34.
  • Updated Material for MkDocs dependencies #37.
  • Fixed incorrect overwrite of files without generator: doxide in YAML frontmatter. Warning now produced, and file is not overwritten.
doxide -

Published by lawmurray 12 months ago

  • Fixed handling of conversion operators, e.g. operator int() (#31, example here).
doxide -

Published by lawmurray 12 months ago

  • New defines section in configuration file for defining preprocessor symbols (documentation, more documentation, #12).
  • New error recovery logic to autocorrect common parsing issues related to preprocessor symbols (documentation, #12).
  • Improved reporting of parse errors, identifying line and column numbers (#22).
doxide -

Published by lawmurray almost 1 year ago

  • Fixes and improvements to template parsing.
  • Fixes for Windows dependencies.
doxide -

Published by lawmurray about 1 year ago

  • Simplified parsing under the hood and fixed some parsing bugs.
  • End-of-line comments now supported for all entity types (previously only variables, enumerations, and macros).
doxide -

Published by lawmurray about 1 year ago

Expanded documentation comments from /** ... */ to include these additional styles:

  • Before entities: /*! ... */, /// ..., and //! ....
  • After entities (e.g. end of line comment): /**< ... */, /*!< ... */, ///< ..., and //!< ....

Addresses #21.

doxide - v0.2.3

Published by lawmurray about 1 year ago

  • Fixes for unicode characters used in entity names (#24).
  • Generated Markdown links are now to source files rather than published URLs to improve portability (and silence MkDocs warnings).
doxide - v0.2.2

Published by lawmurray about 1 year ago

  • Fixes for extraction of brief documentation in cases where there is no complete sentence to extract.
  • Fixes for some syntax resulting in whole function, not just function signature, being extracted to documentation.
doxide -

Published by lawmurray about 1 year ago

  • Fixes for functions that return reference or pointer type.
  • Inner classes now included in documentation.