In addition to snippets manipulation that is applicable to any language, Znai can extract content of methods. Head over to Java Content Extraction to learn more :include-java: HelloWorld.java { entry: "sampleMethod", commentsType: "inline", bodyOnly: true } validate(); process(p2); // important comment notifyAll(p1); // very important return bestSample();
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 API Parameters Head over to Java Description Extraction to learn more :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
Auto reference similar to Python is planned for the future releases. Create a GitHub Issue or Discussion to help prioritize