Minor documentation formatting.
This commit is contained in:
parent
928c1ebe3b
commit
477233d020
@ -1,6 +1,6 @@
|
|||||||
<project name="Jonathan's Literate Programming" basedir="." default="release">
|
<project name="Jonathan's Literate Programming" basedir="." default="release">
|
||||||
|
|
||||||
<import file="jdb-build-1.9.xml"/>
|
<import file="jdb-build-1.10.xml"/>
|
||||||
<property environment="env"/>
|
<property environment="env"/>
|
||||||
<property file="project.properties"/>
|
<property file="project.properties"/>
|
||||||
|
|
||||||
|
@ -117,7 +117,7 @@
|
|||||||
<target name="-compile-groovy" depends="-init,-init-groovy,-lib,-lib-groovy">
|
<target name="-compile-groovy" depends="-init,-init-groovy,-lib,-lib-groovy">
|
||||||
<mkdir dir="${build.dir}/main/classes"/>
|
<mkdir dir="${build.dir}/main/classes"/>
|
||||||
<groovyc srcdir="${src.dir}/main" destdir="${build.dir}/main/classes"
|
<groovyc srcdir="${src.dir}/main" destdir="${build.dir}/main/classes"
|
||||||
includeAntRuntime="false">
|
includeAntRuntime="false" fork="true">
|
||||||
|
|
||||||
<classpath>
|
<classpath>
|
||||||
<path refid="groovy.classpath"/>
|
<path refid="groovy.classpath"/>
|
||||||
@ -139,7 +139,7 @@
|
|||||||
<target name="-compile-tests-groovy" depends="-init,compile">
|
<target name="-compile-tests-groovy" depends="-init,compile">
|
||||||
<mkdir dir="${build.dir}/test/classes"/>
|
<mkdir dir="${build.dir}/test/classes"/>
|
||||||
<groovyc srcdir="${src.dir}/test" destdir="${build.dir}/test/classes"
|
<groovyc srcdir="${src.dir}/test" destdir="${build.dir}/test/classes"
|
||||||
includeAntRuntime="false">
|
includeAntRuntime="false" fork="true">
|
||||||
|
|
||||||
<classpath>
|
<classpath>
|
||||||
<path refid="groovy.classpath"/>
|
<path refid="groovy.classpath"/>
|
@ -1,7 +1,7 @@
|
|||||||
#Fri, 27 Jan 2012 18:21:58 -0600
|
#Tue, 13 Aug 2013 08:48:43 -0500
|
||||||
name=jlp
|
name=jlp
|
||||||
version=1.7
|
version=1.7
|
||||||
build.number=24
|
build.number=25
|
||||||
lib.local=true
|
lib.local=true
|
||||||
release.dir=release
|
release.dir=release
|
||||||
main.class=com.jdblabs.jlp.JLPMain
|
main.class=com.jdblabs.jlp.JLPMain
|
||||||
|
@ -18,7 +18,7 @@ public abstract class JLPBaseGenerator {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* The generator works in close conjunction with a JLP Processor.
|
* 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
|
* between the two classes is scope. The Processor class is concerned with
|
||||||
* data and behavior common to the whole documentation process whereas the
|
* data and behavior common to the whole documentation process whereas the
|
||||||
* Generator is concerned only with one file. The Generator does have
|
* Generator is concerned only with one file. The Generator does have
|
||||||
|
@ -37,19 +37,19 @@ public class JLPMain {
|
|||||||
/// : Print help information.
|
/// : Print help information.
|
||||||
cli.h('Print this help information.', longOpt: 'help', required: false)
|
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
|
/// : Set the output directory where the documentation will be
|
||||||
/// written.
|
/// written.
|
||||||
cli.o("Output directory (defaults to 'jlp-docs').",
|
cli.o("Output directory (defaults to 'jlp-docs').",
|
||||||
longOpt: 'output-dir', args: 1, argName: "output-dir",
|
longOpt: 'output-dir', args: 1, argName: "output-dir",
|
||||||
required: false)
|
required: false)
|
||||||
|
|
||||||
/// --css-file
|
/// --css-file <file>
|
||||||
/// : Specify an alternate CSS file for the output documentation.
|
/// : Specify an alternate CSS file for the output documentation.
|
||||||
cli._('Use <css-file> for the documentation css.',
|
cli._('Use <css-file> for the documentation css.',
|
||||||
longOpt: 'css-file', args: 1, required: false, argName: 'css-file')
|
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
|
/// : Override the current working directory. This is useful if you
|
||||||
/// are invoking jlp remotely, or if the current working directory
|
/// are invoking jlp remotely, or if the current working directory
|
||||||
/// is incorrectly set by the executing environment.
|
/// is incorrectly set by the executing environment.
|
||||||
|
@ -130,10 +130,8 @@ public class Processor {
|
|||||||
def relPath = getRelativeFilepath(inputRoot, file)
|
def relPath = getRelativeFilepath(inputRoot, file)
|
||||||
def pathParts = relPath.split('/') as List
|
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.
|
// We will skip binary files and files we know nothing about.
|
||||||
|
def fileType = sourceTypeForFile(file)
|
||||||
if (fileType == 'binary' || fileType == 'unknown') { return; }
|
if (fileType == 'binary' || fileType == 'unknown') { return; }
|
||||||
|
|
||||||
// Start with just the file name.
|
// Start with just the file name.
|
||||||
|
Loading…
Reference in New Issue
Block a user