Skip to content

Commit

Permalink
All sorts of JavaDoc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
ndw committed Apr 19, 2016
1 parent ea6a8ba commit 4be34bd
Show file tree
Hide file tree
Showing 138 changed files with 241 additions and 217 deletions.
18 changes: 9 additions & 9 deletions src/main/java/com/xmlcalabash/core/XProcException.java
Original file line number Diff line number Diff line change
Expand Up @@ -39,51 +39,51 @@ public class XProcException extends RuntimeException {
private Step step = null;
private XdmNode node = null;

/** Creates a new instance of XProcException */
/* Creates a new instance of XProcException */
public XProcException() {
super();
}

/** Creates a new instance of XProcException */
/* Creates a new instance of XProcException */
public XProcException(String message) {
super(message);
}

/** Creates a new instance of XProcException */
/* Creates a new instance of XProcException */
public XProcException(Step step, String message) {
super(message);
this.step = step;
}

/** Creates a new instance of XProcException */
/* Creates a new instance of XProcException */
public XProcException(XdmNode node, String message) {
super(message);
this.node = node;
}

/** Creates a new instance of XProcException */
/* Creates a new instance of XProcException */
public XProcException(String message, Throwable cause) {
super(message, cause);
}

/** Creates a new instance of XProcException */
/* Creates a new instance of XProcException */
public XProcException(Step step, String message, Throwable cause) {
super(message, cause);
this.step = step;
}

/** Creates a new instance of XProcException */
/* Creates a new instance of XProcException */
public XProcException(Throwable cause) {
super(cause);
}

/** Creates a new instance of XProcException */
/* Creates a new instance of XProcException */
public XProcException(XdmNode node, Throwable cause) {
super(cause);
this.node = node;
}

/** Creates a new instance of XProcException */
/* Creates a new instance of XProcException */
public XProcException(XdmNode node, String message, Throwable cause) {
super(message, cause);
this.node = node;
Expand Down
24 changes: 12 additions & 12 deletions src/main/java/com/xmlcalabash/drivers/CalabashTask.java
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
/**
* Ant task to run Calabash.
*
* <p>Owes a lot to Ant's &lt;xslt> task, but this task can't become
* <p>Owes a lot to Ant's &lt;xslt&gt; task, but this task can't become
* part of Ant because this task relies on Calabash, which is licensed
* under LGPL.
*
Expand Down Expand Up @@ -302,15 +302,15 @@ public void addConfiguredInput(Input input) {
}
}

/**
/*
* Whether the build should fail if the nested resource collection is empty.
*/
public void setFailOnNoResources(boolean b) {
failOnNoResources = b;
}

/**
* Set the pipeline. optional, nested &lt;pipeline> will be used if not set.
* Set the pipeline. optional, nested &lt;pipeline&gt; will be used if not set.
*
* @param pipeline pipeline location
*/
Expand Down Expand Up @@ -379,7 +379,7 @@ public void setOut(Resource outResource) {
}

/**
* Work with an instance of an <output> element already configured by Ant.
* Work with an instance of an &lt;output&gt; element already configured by Ant.
*
* @param o the configured Port
*/
Expand Down Expand Up @@ -438,7 +438,7 @@ public void setExtension(String name) {
isTargetExtensionSet = true;
}

/**
/*
* Whether any errors should make the build fail.
*/
public void setFailOnError(boolean b) {
Expand Down Expand Up @@ -510,22 +510,22 @@ public void setForce(boolean force) {
this.force = force;
}

/**
/*
* A system property to set during transformation.
*/
public void addSysproperty(Environment.Variable sysp) {
sysProperties.addVariable(sysp);
}

/**
/*
* A set of system properties to set during transformation.
*/
public void addSyspropertyset(PropertySet sysp) {
sysProperties.addSyspropertyset(sysp);
}

/**
* Work with an instance of a <binding> element already configured by Ant.
* Work with an instance of a &lt;binding&gt; element already configured by Ant.
*
* @param namespace the configured Namespace
*/
Expand Down Expand Up @@ -555,7 +555,7 @@ public void addConfiguredNamespace(Namespace namespace) {
}

/**
* Work with an instance of a <option> element already configured by Ant.
* Work with an instance of a &lt;option&gt; element already configured by Ant.
*
* @param option the configured Option
*/
Expand Down Expand Up @@ -587,7 +587,7 @@ public void useOption(Option option) {
}

/**
* Work with an instance of a <parameter> element already configured by Ant.
* Work with an instance of a &lt;parameter&gt; element already configured by Ant.
*
* @param parameter the configured Parameter
*/
Expand Down Expand Up @@ -1344,7 +1344,7 @@ private void checkDest() {
}
}

/**
/*
* Throws an exception with the given message if failOnError is
* true, otherwise logs the message using the WARN level.
*/
Expand All @@ -1355,7 +1355,7 @@ protected void handleError(String msg) {
log(msg, Project.MSG_WARN);
}

/**
/*
* Throws an exception with the given nested exception if
* failOnError is true, otherwise logs the message using the WARN level.
*/
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/xmlcalabash/drivers/Main.java
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ public class Main {
private boolean debug = false;
private int chaseMemoryLeaks = 0;

/**
/*
* @param args the command line arguments
*/
public static void main(String[] args) throws IOException {
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/xmlcalabash/drivers/RunTestReport.java
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ public class RunTestReport {
protected Logger logger = LoggerFactory.getLogger(RunTestReport.class);


/** Creates a new instance of RunTest */
/* Creates a new instance of RunTest */
public RunTestReport(XProcRuntime runtime, TestReporter reporter) {
this.runtime = runtime;
this.reporter = reporter;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ public class CollectionManager extends DefaultStep {
private ReadablePipe source = null;
private WritablePipe result = null;

/**
* Creates a new instance of Identity
/*
* Creates a new instance of CollectionManager
*/
public CollectionManager(XProcRuntime runtime, XAtomicStep step) {
super(runtime,step);
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/xmlcalabash/extensions/CssFormatter.java
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ public class CssFormatter extends DefaultStep {
private WritablePipe result = null;
private Properties options = new Properties();

/** Creates a new instance of Unzip */
/* Creates a new instance of Unzip */
public CssFormatter(XProcRuntime runtime, XAtomicStep step) {
super(runtime,step);
}
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/xmlcalabash/extensions/Eval.java
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ public class Eval extends DefaultStep {
private Vector<ReadablePipe> options = new Vector<ReadablePipe> ();
private WritablePipe result = null;

/**
/*
* Creates a new instance of Eval
*/
public Eval(XProcRuntime runtime, XAtomicStep step) {
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/xmlcalabash/extensions/GetCookies.java
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ public class GetCookies extends DefaultStep {
private static DateFormat iso8601 = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ssZ");
private WritablePipe result = null;

/**
/*
* Creates a new instance of Identity
*/
public GetCookies(XProcRuntime runtime, XAtomicStep step) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ public class JavaProperties extends DefaultStep {
private static final QName _value = new QName("value");
private WritablePipe result = null;

/**
/*
* Creates a new instance of Identity
*/
public JavaProperties(XProcRuntime runtime, XAtomicStep step) {
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/xmlcalabash/extensions/Message.java
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public class Message extends DefaultStep {
private ReadablePipe source = null;
private WritablePipe result = null;

/**
/*
* Creates a new instance of Identity
*/
public Message(XProcRuntime runtime, XAtomicStep step) {
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/xmlcalabash/extensions/NVDL.java
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ public class NVDL extends DefaultStep {
private ReadablePipe schemaSource = null;
private WritablePipe result = null;

/** Creates a new instance of Delete */
/* Creates a new instance of Delete */
public NVDL(XProcRuntime runtime, XAtomicStep step) {
super(runtime,step);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public class NamespaceDelete extends DefaultStep {
private ReadablePipe source = null;
private WritablePipe result = null;

/**
/*
* Creates a new instance of NamespaceDelete
*/
public NamespaceDelete(XProcRuntime runtime, XAtomicStep step) {
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/com/xmlcalabash/extensions/ReportErrors.java
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ public class ReportErrors extends DefaultStep {
private ReadablePipe report = null;
private WritablePipe result = null;

/**
* Creates a new instance of Identity
/*
* Creates a new instance of ReportErrors
*/
public ReportErrors(XProcRuntime runtime, XAtomicStep step) {
super(runtime,step);
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/xmlcalabash/extensions/SetBaseURI.java
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public class SetBaseURI extends DefaultStep {
private TreeWriter tree = null;
private URI baseURI = null;

/**
/*
* Creates a new instance of SetBaseURI
*/
public SetBaseURI(XProcRuntime runtime, XAtomicStep step) {
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/xmlcalabash/extensions/SetCookies.java
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ public class SetCookies extends DefaultStep {
private static DateFormat iso8601 = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss");
private ReadablePipe source = null;

/**
/*
* Creates a new instance of Identity
*/
public SetCookies(XProcRuntime runtime, XAtomicStep step) {
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/xmlcalabash/extensions/Uncompress.java
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ public class Uncompress extends DefaultStep {
private ReadablePipe source = null;
private WritablePipe result = null;

/**
/*
* Creates a new instance of Load
*/
public Uncompress(XProcRuntime runtime, XAtomicStep step) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
public class UntilUnchanged extends DeclareStep {
private Output output = null;

/** Creates a new instance of UntilUnchanged */
/* Creates a new instance of UntilUnchanged */
public UntilUnchanged(XProcRuntime xproc, XdmNode node, String name) {
super(xproc, node, name);
declaration = this;
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/xmlcalabash/extensions/Unzip.java
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ public class Unzip extends DefaultStep {
private String contentType = "application/xml";
private String charset = null;

/** Creates a new instance of Unzip */
/* Creates a new instance of Unzip */
public Unzip(XProcRuntime runtime, XAtomicStep step) {
super(runtime,step);
}
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/xmlcalabash/extensions/UriInfo.java
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ public class UriInfo extends DefaultStep {

private WritablePipe result = null;

/**
/*
* Creates a new instance of UriInfo
*/
public UriInfo(XProcRuntime runtime, XAtomicStep step) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ public class WaitForUpdate extends DefaultStep {
private long pauseBefore = 0;
private long pauseAfter = 0;

/**
/*
* Creates a new instance of Identity
*/
public WaitForUpdate(XProcRuntime runtime, XAtomicStep step) {
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/xmlcalabash/extensions/Zip.java
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ public class Zip extends DefaultStep {
private Map<String, FileToZip> zipManifest = new LinkedHashMap<String, FileToZip> ();
private Map<String, XdmNode> srcManifest = new LinkedHashMap<String, XdmNode> ();

/** Creates a new instance of Unzip */
/* Creates a new instance of Unzip */
public Zip(XProcRuntime runtime, XAtomicStep step) {
super(runtime,step);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ public class Copy extends DefaultStep {

private WritablePipe result = null;

/**
/*
* Creates a new instance of UriInfo
*/
public Copy(XProcRuntime runtime, XAtomicStep step) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ public class Delete extends DefaultStep {

private WritablePipe result = null;

/**
/*
* Creates a new instance of UriInfo
*/
public Delete(XProcRuntime runtime, XAtomicStep step) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ public class Head extends DefaultStep {

private WritablePipe result = null;

/**
/*
* Creates a new instance of UriInfo
*/
public Head(XProcRuntime runtime, XAtomicStep step) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ public class Info extends DefaultStep {

private WritablePipe result = null;

/**
/*
* Creates a new instance of UriInfo
*/
public Info(XProcRuntime runtime, XAtomicStep step) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ public class Mkdir extends DefaultStep {

private WritablePipe result = null;

/**
/*
* Creates a new instance of UriInfo
*/
public Mkdir(XProcRuntime runtime, XAtomicStep step) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ public class Move extends DefaultStep {

private WritablePipe result = null;

/**
/*
* Creates a new instance of UriInfo
*/
public Move(XProcRuntime runtime, XAtomicStep step) {
Expand Down
Loading

0 comments on commit 4be34bd

Please sign in to comment.