Content Extraction

In addition to snippets/snippets-manipulation snippets manipulation that is applicable to any language, Znai can extract content of methods. :include-java: HelloWorld.java { entry: "sampleMethod", commentsType: "inline", bodyOnly: true } validate(); process(p2); // important comment notifyAll(p1); // very important return bestSample(); Head over to java/content-extraction Java Content Extraction to learn more

Description Extraction

Znai provides plugin to extract JavaDoc content. Use it to extract high level description and merge it with the rest of the documentation. Convert Enums and method parameters into snippets/api-parameters API Parameters :include-java-doc-params: HelloWorld.java { entry: "importantAction", title: "Trading Required Parameters", referencesPath: "references/javadoc-references-demo.csv" } trader Trader trader that performs action transaction Transaction transaction to perform action on Head over to java/description-extraction Java Description Extraction to learn more

Auto Reference

Auto reference similar to python/content-extraction Python is planned for the future releases.Create a https://github.com/testingisdocumenting/znai/issues GitHub Issue or https://github.com/testingisdocumenting/znai/discussions Discussion to help prioritize