docProcessorGradlePlugin

Gradle Plugin: KDoc / JavaDoc Preprocessor that can produce modified sources

MIT License

Stars
19

Bot releases are visible (Hide)

docProcessorGradlePlugin - v0.3.10 Latest Release

Published by Jolanrensen 4 months ago

What's Changed

Full Changelog: https://github.com/Jolanrensen/docProcessorGradlePlugin/compare/v0.3.9...v0.3.10

docProcessorGradlePlugin - v0.3.9

Published by Jolanrensen 4 months ago

docProcessorGradlePlugin - v0.3.8

Published by Jolanrensen 4 months ago

docProcessorGradlePlugin - v0.3.7

Published by Jolanrensen 5 months ago

What's Changed

  • fixed exception on windows

Full Changelog: https://github.com/Jolanrensen/docProcessorGradlePlugin/compare/v0.3.6...v0.3.7

docProcessorGradlePlugin - v0.3.6

Published by Jolanrensen 5 months ago

What's Changed

  • changed outputs.upToDateWhen {} to be more relaxed. The Gradle plugin should run less often and only when needed
  • Gradle output attempts to be read only

Full Changelog: https://github.com/Jolanrensen/docProcessorGradlePlugin/compare/v0.3.5...v0.3.6

docProcessorGradlePlugin - v0.3.5

Published by Jolanrensen 6 months ago

What's Changed

Full Changelog: https://github.com/Jolanrensen/docProcessorGradlePlugin/compare/v0.3.4...v0.3.5

  • Doc processors can now run in parallel (enabled by default in TagDocProcessor with canProcessParallel). This is disabled for @include to prevent concurrent modifications.
  • Include can now pre-sort docs (can be disabled by setting the argument INCLUDE_DOC_PROCESSOR_PRE_SORT to false) before running. This analyses the docs in O(n), creates a dependency graph which then outputs an order in such a way that each doc can be rendered in one go, O(n) again. This is different from before where some parts of text could be processed multiple times. In practice or with smaller code bases, the performance could be worse with pre-sorting (as all docs now have to be analysed twice), but in larger code bases you might notice a difference.
  • Generating a dependency graph is done by IncludeDocAnalyzer, a TagDocAnalyser which is the same as a TagDocProcessor but without changing the docs.
  • Added speed indicators to the lifecycle of the gradle plugin.
  • The most interesting part now is the IntelliJ plugin. I wanted to have support for the "rendered docs" feature of IntelliJ which could display, well, rendered docs right next to the code. However, since the plugin works one doc at a time, this very quickly became very slow. So, I changed DocumentablesByPathWithCache to an advanced caching system, taking track of changes in a doc + doc @include dependencies with a dependency graph again. I cache both the doc content results (the final rendered doc), as well as a post-include state. This post-include state cache is to prevent deep @include paths with many queries and just overall less work, similar to pre-sort for the gradle plugin.
    The result is a way faster experience, especially when you're not modifying code (it can just load the cache) and, when "Render all doc comments" is enabled, you can modify one doc and see (relatively) live results in docs dependent on it!
docProcessorGradlePlugin - v0.3.4

Published by Jolanrensen 7 months ago

docProcessorGradlePlugin - v0.3.3

Published by Jolanrensen 8 months ago

What's Changed

Full Changelog: https://github.com/Jolanrensen/docProcessorGradlePlugin/compare/v0.3.2...v0.3.3

docProcessorGradlePlugin - v0.3.2 Beta!

Published by Jolanrensen 9 months ago

What's Changed

Full Changelog: https://github.com/Jolanrensen/docProcessorGradlePlugin/compare/v0.2.2...v0.3.2

docProcessorGradlePlugin - v0.2.3

Published by Jolanrensen about 1 year ago

docProcessorGradlePlugin - v0.2.2 (broken, use v0.2.1)

Published by Jolanrensen about 1 year ago

Fixed inheritance support in gradle plugin.

EDIT: Looks like this version has become terribly slow, use v0.2.1 in the meantime

What's Changed

Full Changelog: https://github.com/Jolanrensen/docProcessorGradlePlugin/compare/v0.2.1...v0.2.2

docProcessorGradlePlugin - v0.2.1

Published by Jolanrensen over 1 year ago

Added arguments option and the option to turn off logs for @arg/@includeArg

Full Changelog: https://github.com/Jolanrensen/docProcessorGradlePlugin/compare/v0.2.0...v0.2.1

docProcessorGradlePlugin - v0.2.0

Published by Jolanrensen over 1 year ago

Fixed https://github.com/Jolanrensen/docProcessorGradlePlugin/issues/20

IntelliJ plugin is now part of the project. This doesn't affect the gradle plugin, but does affect the project layout, hence the new version.

What's Changed

Full Changelog: https://github.com/Jolanrensen/docProcessorGradlePlugin/compare/v0.1.6...v0.2.0

docProcessorGradlePlugin - v0.1.6

Published by Jolanrensen over 1 year ago

Fixed NoSuchMethodError IncrementalCompilationOptions in implementing projects

Full Changelog: https://github.com/Jolanrensen/docProcessorGradlePlugin/compare/v0.1.5...v0.1.6

docProcessorGradlePlugin - v0.1.5

Published by Jolanrensen over 1 year ago

docProcessorGradlePlugin - v0.1.4

Published by Jolanrensen over 1 year ago

docProcessorGradlePlugin - v0.1.1

Published by Jolanrensen over 1 year ago

docProcessorGradlePlugin - v0.1.0

Published by Jolanrensen over 1 year ago

After the second round of reviews, we can move from the snapshot level to alpha :)
I'll remove the pre-release label for now.

Full Changelog: https://github.com/Jolanrensen/docProcessorGradlePlugin/compare/v0.0.31...v0.1.0

docProcessorGradlePlugin - v0.0.31

Published by Jolanrensen over 1 year ago

docProcessorGradlePlugin - v0.0.30

Published by Jolanrensen over 1 year ago

Better error reporting with clickable links :)
Full Changelog: https://github.com/Jolanrensen/docProcessorGradlePlugin/compare/v0.0.29...v0.0.30

Badges
Extracted from project README
Maven metadata URL