You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nifi.apache.org by ma...@apache.org on 2022/10/28 18:13:57 UTC
[nifi] branch main updated: NIFI-10704 - include API name of properties in processor documentation
This is an automated email from the ASF dual-hosted git repository.
mattyb149 pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/nifi.git
The following commit(s) were added to refs/heads/main by this push:
new 61ccb23b47 NIFI-10704 - include API name of properties in processor documentation
61ccb23b47 is described below
commit 61ccb23b47c45ea3e64e0931dbec421a3f6a7d1b
Author: Paul Grey <gr...@yahoo.com>
AuthorDate: Wed Oct 26 20:25:57 2022 -0400
NIFI-10704 - include API name of properties in processor documentation
Signed-off-by: Matthew Burgess <ma...@apache.org>
This closes #6586
---
.../org/apache/nifi/documentation/html/HtmlDocumentationWriter.java | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-documentation/src/main/java/org/apache/nifi/documentation/html/HtmlDocumentationWriter.java b/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-documentation/src/main/java/org/apache/nifi/documentation/html/HtmlDocumentationWriter.java
index f96af19616..dcd33f3ad0 100644
--- a/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-documentation/src/main/java/org/apache/nifi/documentation/html/HtmlDocumentationWriter.java
+++ b/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-documentation/src/main/java/org/apache/nifi/documentation/html/HtmlDocumentationWriter.java
@@ -481,7 +481,8 @@ public class HtmlDocumentationWriter implements DocumentationWriter {
// write the header row
xmlStreamWriter.writeStartElement("tr");
- writeSimpleElement(xmlStreamWriter, "th", "Name");
+ writeSimpleElement(xmlStreamWriter, "th", "Display Name");
+ writeSimpleElement(xmlStreamWriter, "th", "API Name");
writeSimpleElement(xmlStreamWriter, "th", "Default Value");
writeSimpleElement(xmlStreamWriter, "th", "Allowable Values");
writeSimpleElement(xmlStreamWriter, "th", "Description");
@@ -499,6 +500,7 @@ public class HtmlDocumentationWriter implements DocumentationWriter {
}
xmlStreamWriter.writeEndElement();
+ writeSimpleElement(xmlStreamWriter, "td", property.getName());
writeSimpleElement(xmlStreamWriter, "td", getDefaultValue(property), "default-value");
xmlStreamWriter.writeStartElement("td");
xmlStreamWriter.writeAttribute("id", "allowable-values");