[
https://issues.apache.org/jira/browse/NIFI-15574?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Daniel Stieglitz updated NIFI-15574:
------------------------------------
Description:
The point of this ticket is replace <pre><code> tags found in the NIFI API
javadoc with the snippet tag. The snippet tag allows for including actual Java
code in the Javadocs without the need to do any escaping. In addition it allows
for specifying other languages such as JSON, property files and plain text.
More information regarding the snippet tag can be seen in the following
[article|https://blogs.oracle.com/javamagazine/java-javadoc-snippet/].
was:
The point of this ticket is replace <pre><code> tags with the snippet tag. The
snippet tag allows for including actual Java code in the Javadocs without the
need to do any escaping.
More information regarding the snippet tag can be seen in the following
[article|https://blogs.oracle.com/javamagazine/java-javadoc-snippet/].
> Introduce the Javadoc snippet tag for the code examples in the Nifi API
> Javadocs
> --------------------------------------------------------------------------------
>
> Key: NIFI-15574
> URL: https://issues.apache.org/jira/browse/NIFI-15574
> Project: Apache NiFi
> Issue Type: Improvement
> Components: NiFi API
> Reporter: Daniel Stieglitz
> Assignee: Daniel Stieglitz
> Priority: Minor
>
> The point of this ticket is replace <pre><code> tags found in the NIFI API
> javadoc with the snippet tag. The snippet tag allows for including actual
> Java code in the Javadocs without the need to do any escaping. In addition it
> allows for specifying other languages such as JSON, property files and plain
> text.
> More information regarding the snippet tag can be seen in the following
> [article|https://blogs.oracle.com/javamagazine/java-javadoc-snippet/].
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
