BATCHEE-104 BATCHEE-105 few tweaks on the documentation generation
diff --git a/extensions/extension-doc-helper/pom.xml b/extensions/extension-doc-helper/pom.xml
index 1363091..48e6aaf 100644
--- a/extensions/extension-doc-helper/pom.xml
+++ b/extensions/extension-doc-helper/pom.xml
@@ -110,7 +110,7 @@
def generatedFolder = new File(project.parent.parent.basedir, 'src/site/markdown/batchee-site-generated')
if (!generatedFolder.isDirectory()) throw new IllegalStateException('no generated doc, extensions pre-ste should have been executed')
new File(generatedFolder, 'index.md').withWriter { w ->
- w.println('= Generated Extensions Documentation\n')
+ w.println('# Generated Extensions Documentation\n')
generatedFolder.listFiles(new FilenameFilter() {
boolean accept(File dir, String name) {
@@ -118,7 +118,7 @@
}
}).sort(true) { f1, f2 -> f1.name.compareTo(f2.name) }.each {
if (it.name == 'index.md') return
- w.println('* [' + it.name + '](./' + it.name.replace('.md', '.html') + ')')
+ w.println('* [' + it.name.replace('.md', '').replace('batchee-', '').capitalize() + '](./' + it.name.replace('.md', '.html') + ')')
}
}
]]>
diff --git a/tools/maven-plugin/src/main/java/org/apache/batchee/tools/maven/doc/ComponentDocumentationGenerator.java b/tools/maven-plugin/src/main/java/org/apache/batchee/tools/maven/doc/ComponentDocumentationGenerator.java
index 6b8d3af..00c74df 100644
--- a/tools/maven-plugin/src/main/java/org/apache/batchee/tools/maven/doc/ComponentDocumentationGenerator.java
+++ b/tools/maven-plugin/src/main/java/org/apache/batchee/tools/maven/doc/ComponentDocumentationGenerator.java
@@ -197,7 +197,7 @@
@Override
public void add(final Writer writer, final FieldDoc doc) throws IOException {
- writer.append("* ").append(doc.getName()).append(doc.getDoc() == null ? "" : ": " + doc.getDoc()).append("\n");
+ writer.append("* `").append(doc.getName()).append('`').append(doc.getDoc() == null ? "" : ": " + doc.getDoc()).append("\n");
}
@Override
diff --git a/tools/maven-plugin/src/test/java/org/apache/batchee/tools/maven/DocumentationMojoTest.java b/tools/maven-plugin/src/test/java/org/apache/batchee/tools/maven/DocumentationMojoTest.java
index 58b086c..a351440 100644
--- a/tools/maven-plugin/src/test/java/org/apache/batchee/tools/maven/DocumentationMojoTest.java
+++ b/tools/maven-plugin/src/test/java/org/apache/batchee/tools/maven/DocumentationMojoTest.java
@@ -85,19 +85,19 @@
"\n" +
"a child comp\n" +
"\n" +
- "* config2: 2\n" +
- "* configByDefault: this is an important config\n" +
- "* expl: this one is less important\n" +
+ "* `config2`: 2\n" +
+ "* `configByDefault`: this is an important config\n" +
+ "* `expl`: this one is less important\n" +
"\n" +
"# myComponent\n" +
"\n" +
- "* configByDefault: this is an important config\n" +
- "* expl: this one is less important\n" +
+ "* `configByDefault`: this is an important config\n" +
+ "* `expl`: this one is less important\n" +
"\n" +
"# org.apache.batchee.tools.maven.batchlet.SimpleBatchlet\n" +
"\n" +
- "* fail\n" +
- "* sleep\n" +
+ "* `fail`\n" +
+ "* `sleep`\n" +
"\n", IOUtil.toString(fis));
fis.close();
}
