Repository: camel Updated Branches: refs/heads/master 86f5e0c50 -> 24d2f4aea
Component docs - Adjust tables to have group label span column which makes more room to show the description as there is one row less. Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/6ec46508 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/6ec46508 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/6ec46508 Branch: refs/heads/master Commit: 6ec46508205d21144c9109ae2ddcedbbfd41a976 Parents: 86f5e0c Author: Claus Ibsen <davscl...@apache.org> Authored: Fri Mar 17 10:44:53 2017 +0100 Committer: Claus Ibsen <davscl...@apache.org> Committed: Fri Mar 17 10:44:53 2017 +0100 ---------------------------------------------------------------------- .../camel/maven/packaging/UpdateReadmeMojo.java | 14 ++++++++++++++ .../maven/packaging/model/ComponentOptionModel.java | 11 +++++++++++ .../maven/packaging/model/EndpointOptionModel.java | 11 +++++++++++ .../src/main/resources/component-options.mvel | 7 ++++--- .../src/main/resources/endpoint-options.mvel | 7 ++++--- 5 files changed, 44 insertions(+), 6 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/6ec46508/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/UpdateReadmeMojo.java ---------------------------------------------------------------------- diff --git a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/UpdateReadmeMojo.java b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/UpdateReadmeMojo.java index 837f5bf..45200b0 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/UpdateReadmeMojo.java +++ b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/UpdateReadmeMojo.java @@ -774,6 +774,7 @@ public class UpdateReadmeMojo extends AbstractMojo { component.setArtifactId(getSafeValue("artifactId", rows)); component.setVersion(getSafeValue("version", rows)); + String oldGroup = null; rows = parseJsonSchema("componentProperties", json, true); for (Map<String, String> row : rows) { ComponentOptionModel option = new ComponentOptionModel(); @@ -795,8 +796,15 @@ public class UpdateReadmeMojo extends AbstractMojo { option.setDescription(desc); } component.addComponentOption(option); + + // group separate between different options + if (oldGroup == null || !oldGroup.equals(option.getGroup())) { + option.setNewGroup(true); + } + oldGroup = option.getGroup(); } + oldGroup = null; rows = parseJsonSchema("properties", json, true); for (Map<String, String> row : rows) { EndpointOptionModel option = new EndpointOptionModel(); @@ -825,6 +833,12 @@ public class UpdateReadmeMojo extends AbstractMojo { } else { component.addEndpointOption(option); } + + // group separate between different options + if (oldGroup == null || !oldGroup.equals(option.getGroup())) { + option.setNewGroup(true); + } + oldGroup = option.getGroup(); } return component; http://git-wip-us.apache.org/repos/asf/camel/blob/6ec46508/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/model/ComponentOptionModel.java ---------------------------------------------------------------------- diff --git a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/model/ComponentOptionModel.java b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/model/ComponentOptionModel.java index e1c0697..5b79f61 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/model/ComponentOptionModel.java +++ b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/model/ComponentOptionModel.java @@ -31,6 +31,9 @@ public class ComponentOptionModel { private String defaultValue; private String enums; + // special for documentation rendering + private boolean newGroup; + public String getName() { return name; } @@ -127,6 +130,14 @@ public class ComponentOptionModel { this.enums = enums; } + public boolean isNewGroup() { + return newGroup; + } + + public void setNewGroup(boolean newGroup) { + this.newGroup = newGroup; + } + public String getShortJavaType() { if (javaType.startsWith("java.util.Map")) { return "Map"; http://git-wip-us.apache.org/repos/asf/camel/blob/6ec46508/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/model/EndpointOptionModel.java ---------------------------------------------------------------------- diff --git a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/model/EndpointOptionModel.java b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/model/EndpointOptionModel.java index 1cb6ed9..d71596d 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/model/EndpointOptionModel.java +++ b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/model/EndpointOptionModel.java @@ -34,6 +34,9 @@ public class EndpointOptionModel { private String description; private String enumValues; + // special for documentation rendering + private boolean newGroup; + public String getName() { return name; } @@ -154,6 +157,14 @@ public class EndpointOptionModel { this.enumValues = enumValues; } + public boolean isNewGroup() { + return newGroup; + } + + public void setNewGroup(boolean newGroup) { + this.newGroup = newGroup; + } + public String getShortJavaType() { if (javaType.startsWith("java.util.Map")) { return "Map"; http://git-wip-us.apache.org/repos/asf/camel/blob/6ec46508/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel ---------------------------------------------------------------------- diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel index 6831302..70012fc 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel +++ b/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel @@ -5,9 +5,10 @@ The @{title} component supports @{componentOptions.size()} options which are lis @end{} @if{!componentOptions.isEmpty()} -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -@foreach{row : componentOptions}| @{row.name} | @{row.group} | @{row.defaultValue} | @{row.shortJavaType} | @{row.description} +| Name | Default | Java Type | Description +@foreach{row : componentOptions}@if{row.newGroup} 4+^s| @{row.group}@end{} +| @{row.name} | @{row.defaultValue} | @{row.shortJavaType} | @{row.description} @end{}|======================================================================= @end{} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/6ec46508/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel ---------------------------------------------------------------------- diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel index 12c3fb3..69d3d37 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel +++ b/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel @@ -14,8 +14,9 @@ with the following path and query parameters: #### Query Parameters (@{endpointOptions.size()} parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -@foreach{row : endpointOptions}| @{row.name} | @{row.group} | @{row.defaultValue} | @{row.shortJavaType} | @{row.description} +| Name | Default | Java Type | Description +@foreach{row : endpointOptions}@if{row.newGroup} 4+^s| @{row.group}@end{} +| @{row.name} | @{row.defaultValue} | @{row.shortJavaType} | @{row.description} @end{}|=======================================================================
