From 477233d02087bbef024f9189fe7283d6d10de908 Mon Sep 17 00:00:00 2001 From: Jonathan Bernard Date: Tue, 13 Aug 2013 09:52:10 -0500 Subject: [PATCH] Minor documentation formatting. --- build.xml | 2 +- jdb-build-1.9.xml => jdb-build-1.10.xml | 4 ++-- project.properties | 4 ++-- src/main/com/jdblabs/jlp/JLPBaseGenerator.groovy | 2 +- src/main/com/jdblabs/jlp/JLPMain.groovy | 6 +++--- src/main/com/jdblabs/jlp/Processor.groovy | 4 +--- 6 files changed, 10 insertions(+), 12 deletions(-) rename jdb-build-1.9.xml => jdb-build-1.10.xml (98%) diff --git a/build.xml b/build.xml index 087350a..7308c2c 100644 --- a/build.xml +++ b/build.xml @@ -1,6 +1,6 @@ - + diff --git a/jdb-build-1.9.xml b/jdb-build-1.10.xml similarity index 98% rename from jdb-build-1.9.xml rename to jdb-build-1.10.xml index 9f92c4f..38056a4 100644 --- a/jdb-build-1.9.xml +++ b/jdb-build-1.10.xml @@ -117,7 +117,7 @@ + includeAntRuntime="false" fork="true"> @@ -139,7 +139,7 @@ + includeAntRuntime="false" fork="true"> diff --git a/project.properties b/project.properties index 0b4c5cd..f1b6937 100644 --- a/project.properties +++ b/project.properties @@ -1,7 +1,7 @@ -#Fri, 27 Jan 2012 18:21:58 -0600 +#Tue, 13 Aug 2013 08:48:43 -0500 name=jlp version=1.7 -build.number=24 +build.number=25 lib.local=true release.dir=release main.class=com.jdblabs.jlp.JLPMain diff --git a/src/main/com/jdblabs/jlp/JLPBaseGenerator.groovy b/src/main/com/jdblabs/jlp/JLPBaseGenerator.groovy index e766ccb..e23f551 100644 --- a/src/main/com/jdblabs/jlp/JLPBaseGenerator.groovy +++ b/src/main/com/jdblabs/jlp/JLPBaseGenerator.groovy @@ -18,7 +18,7 @@ public abstract class JLPBaseGenerator { /** * The generator works in close conjunction with a JLP Processor. - * This tight coupling in intended for these two classes. The distiction + * This tight coupling is intended for these two classes. The distiction * between the two classes is scope. The Processor class is concerned with * data and behavior common to the whole documentation process whereas the * Generator is concerned only with one file. The Generator does have diff --git a/src/main/com/jdblabs/jlp/JLPMain.groovy b/src/main/com/jdblabs/jlp/JLPMain.groovy index 9cbe756..858f1e6 100644 --- a/src/main/com/jdblabs/jlp/JLPMain.groovy +++ b/src/main/com/jdblabs/jlp/JLPMain.groovy @@ -37,19 +37,19 @@ public class JLPMain { /// : Print help information. cli.h('Print this help information.', longOpt: 'help', required: false) - /// -o, --outputdir + /// -o, --outputdir /// : Set the output directory where the documentation will be /// written. cli.o("Output directory (defaults to 'jlp-docs').", longOpt: 'output-dir', args: 1, argName: "output-dir", required: false) - /// --css-file + /// --css-file /// : Specify an alternate CSS file for the output documentation. cli._('Use for the documentation css.', longOpt: 'css-file', args: 1, required: false, argName: 'css-file') - /// --relative-path-root + /// --relative-path-root /// : Override the current working directory. This is useful if you /// are invoking jlp remotely, or if the current working directory /// is incorrectly set by the executing environment. diff --git a/src/main/com/jdblabs/jlp/Processor.groovy b/src/main/com/jdblabs/jlp/Processor.groovy index 855ff8c..c784ef6 100644 --- a/src/main/com/jdblabs/jlp/Processor.groovy +++ b/src/main/com/jdblabs/jlp/Processor.groovy @@ -130,10 +130,8 @@ public class Processor { def relPath = getRelativeFilepath(inputRoot, file) def pathParts = relPath.split('/') as List - // Get our file type. - def fileType = sourceTypeForFile(file) - // We will skip binary files and files we know nothing about. + def fileType = sourceTypeForFile(file) if (fileType == 'binary' || fileType == 'unknown') { return; } // Start with just the file name.