Minor documentation formatting.
This commit is contained in:
@ -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
|
||||
|
@ -37,19 +37,19 @@ public class JLPMain {
|
||||
/// : Print help information.
|
||||
cli.h('Print this help information.', longOpt: 'help', required: false)
|
||||
|
||||
/// -o, --outputdir
|
||||
/// -o, --outputdir <output-directory>
|
||||
/// : 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 <file>
|
||||
/// : Specify an alternate CSS file for the output documentation.
|
||||
cli._('Use <css-file> for the documentation css.',
|
||||
longOpt: 'css-file', args: 1, required: false, argName: 'css-file')
|
||||
|
||||
/// --relative-path-root
|
||||
/// --relative-path-root <root-directory>
|
||||
/// : 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.
|
||||
|
@ -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.
|
||||
|
Reference in New Issue
Block a user