Skip to content

Commit 5728b4f

Browse files
authored
Update the Ascidoc doc generator format for settings
2 parents 02c23b6 + 81f98d5 commit 5728b4f

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

common/src/main/java/com/datastax/oss/common/sink/config/AsciiDocGenerator.java

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -39,21 +39,21 @@ public static String toAscidoc(ConfigDef configDef) {
3939

4040
protected static void getConfigKeyAsciiDoc(
4141
ConfigDef configDef, ConfigDef.ConfigKey key, StringBuilder b) {
42-
b.append("[#").append(key.name).append("]").append("\n");
42+
b.append("``").append(key.name).append("`` +").append("\n");
4343
for (String docLine : key.documentation.split("\n")) {
4444
if (docLine.length() == 0) {
4545
continue;
4646
}
47-
b.append(docLine).append("\n+\n");
47+
b.append(docLine).append("\n\n");
4848
}
49-
b.append("Type: ").append(getConfigValue(key, "Type")).append("\n");
49+
b.append("* Type: ").append(getConfigValue(key, "Type")).append("\n");
5050
if (key.hasDefault()) {
51-
b.append("Default: ").append(getConfigValue(key, "Default")).append("\n");
51+
b.append("* Default: ").append(getConfigValue(key, "Default")).append("\n");
5252
}
5353
if (key.validator != null) {
54-
b.append("Valid Values: ").append(getConfigValue(key, "Valid Values")).append("\n");
54+
b.append("* Valid Values: ").append(getConfigValue(key, "Valid Values")).append("\n");
5555
}
56-
b.append("Importance: ").append(getConfigValue(key, "Importance")).append("\n");
56+
b.append("* Importance: ").append(getConfigValue(key, "Importance")).append("\n");
5757
}
5858

5959
protected static String getConfigValue(ConfigDef.ConfigKey key, String headerName) {
@@ -120,8 +120,7 @@ public static void generateConfigDefDoc(Path path, String name, String title, Co
120120
throws IOException {
121121
try (FileWriter fileWriter = new FileWriter(path.resolve(name).toFile())) {
122122
PrintWriter pw = new PrintWriter(fileWriter);
123-
pw.append("= ").append(title).append("\n\n");
124-
pw.append("== Parameters").append("\n\n");
123+
pw.append("== ").append(title).append("\n\n");
125124
pw.append(toAscidoc(configDef));
126125
pw.flush();
127126
}

0 commit comments

Comments
 (0)