Permalink
Browse files

All sorts of JavaDoc fixes

  • Loading branch information...
ndw committed Apr 19, 2016
1 parent ea6a8ba commit 4be34bda0fd95872c6b494ae85c7aee971445210
Showing with 241 additions and 217 deletions.
  1. +9 −9 src/main/java/com/xmlcalabash/core/XProcException.java
  2. +12 −12 src/main/java/com/xmlcalabash/drivers/CalabashTask.java
  3. +1 −1 src/main/java/com/xmlcalabash/drivers/Main.java
  4. +1 −1 src/main/java/com/xmlcalabash/drivers/RunTestReport.java
  5. +2 −2 src/main/java/com/xmlcalabash/extensions/CollectionManager.java
  6. +1 −1 src/main/java/com/xmlcalabash/extensions/CssFormatter.java
  7. +1 −1 src/main/java/com/xmlcalabash/extensions/Eval.java
  8. +1 −1 src/main/java/com/xmlcalabash/extensions/GetCookies.java
  9. +1 −1 src/main/java/com/xmlcalabash/extensions/JavaProperties.java
  10. +1 −1 src/main/java/com/xmlcalabash/extensions/Message.java
  11. +1 −1 src/main/java/com/xmlcalabash/extensions/NVDL.java
  12. +1 −1 src/main/java/com/xmlcalabash/extensions/NamespaceDelete.java
  13. +2 −2 src/main/java/com/xmlcalabash/extensions/ReportErrors.java
  14. +1 −1 src/main/java/com/xmlcalabash/extensions/SetBaseURI.java
  15. +1 −1 src/main/java/com/xmlcalabash/extensions/SetCookies.java
  16. +1 −1 src/main/java/com/xmlcalabash/extensions/Uncompress.java
  17. +1 −1 src/main/java/com/xmlcalabash/extensions/UntilUnchanged.java
  18. +1 −1 src/main/java/com/xmlcalabash/extensions/Unzip.java
  19. +1 −1 src/main/java/com/xmlcalabash/extensions/UriInfo.java
  20. +1 −1 src/main/java/com/xmlcalabash/extensions/WaitForUpdate.java
  21. +1 −1 src/main/java/com/xmlcalabash/extensions/Zip.java
  22. +1 −1 src/main/java/com/xmlcalabash/extensions/fileutils/Copy.java
  23. +1 −1 src/main/java/com/xmlcalabash/extensions/fileutils/Delete.java
  24. +1 −1 src/main/java/com/xmlcalabash/extensions/fileutils/Head.java
  25. +1 −1 src/main/java/com/xmlcalabash/extensions/fileutils/Info.java
  26. +1 −1 src/main/java/com/xmlcalabash/extensions/fileutils/Mkdir.java
  27. +1 −1 src/main/java/com/xmlcalabash/extensions/fileutils/Move.java
  28. +1 −1 src/main/java/com/xmlcalabash/extensions/fileutils/Tail.java
  29. +1 −1 src/main/java/com/xmlcalabash/extensions/fileutils/Tempfile.java
  30. +1 −1 src/main/java/com/xmlcalabash/extensions/fileutils/Touch.java
  31. +1 −1 src/main/java/com/xmlcalabash/extensions/osutils/Cwd.java
  32. +1 −1 src/main/java/com/xmlcalabash/extensions/osutils/Env.java
  33. +1 −1 src/main/java/com/xmlcalabash/extensions/osutils/Info.java
  34. +9 −1 src/main/java/com/xmlcalabash/io/DataStore.java
  35. +1 −1 src/main/java/com/xmlcalabash/io/FallbackDataStore.java
  36. +1 −1 src/main/java/com/xmlcalabash/io/FileDataStore.java
  37. +1 −1 src/main/java/com/xmlcalabash/io/HttpClientDataStore.java
  38. +1 −1 src/main/java/com/xmlcalabash/io/Pipe.java
  39. +1 −1 src/main/java/com/xmlcalabash/io/ReadableData.java
  40. +1 −1 src/main/java/com/xmlcalabash/io/ReadableDocument.java
  41. +1 −1 src/main/java/com/xmlcalabash/io/ReadableInline.java
  42. +1 −2 src/main/java/com/xmlcalabash/io/Select.java
  43. +1 −1 src/main/java/com/xmlcalabash/io/URLDataStore.java
  44. +1 −1 src/main/java/com/xmlcalabash/io/WritableDocument.java
  45. +1 −1 src/main/java/com/xmlcalabash/library/AddAttribute.java
  46. +1 −1 src/main/java/com/xmlcalabash/library/AddXmlBase.java
  47. +1 −1 src/main/java/com/xmlcalabash/library/Compare.java
  48. +1 −1 src/main/java/com/xmlcalabash/library/Count.java
  49. +1 −1 src/main/java/com/xmlcalabash/library/Delete.java
  50. +1 −1 src/main/java/com/xmlcalabash/library/DirectoryList.java
  51. +1 −1 src/main/java/com/xmlcalabash/library/Error.java
  52. +1 −1 src/main/java/com/xmlcalabash/library/EscapeMarkup.java
  53. +1 −1 src/main/java/com/xmlcalabash/library/Filter.java
  54. +1 −1 src/main/java/com/xmlcalabash/library/Hash.java
  55. +1 −1 src/main/java/com/xmlcalabash/library/HttpRequest.java
  56. +1 −1 src/main/java/com/xmlcalabash/library/Identity.java
  57. +1 −1 src/main/java/com/xmlcalabash/library/InScopeNames.java
  58. +1 −1 src/main/java/com/xmlcalabash/library/Insert.java
  59. +1 −1 src/main/java/com/xmlcalabash/library/LabelElements.java
  60. +1 −1 src/main/java/com/xmlcalabash/library/Load.java
  61. +1 −1 src/main/java/com/xmlcalabash/library/MakeAbsoluteURIs.java
  62. +1 −1 src/main/java/com/xmlcalabash/library/NamespaceRename.java
  63. +1 −1 src/main/java/com/xmlcalabash/library/Pack.java
  64. +1 −1 src/main/java/com/xmlcalabash/library/Parameters.java
  65. +1 −1 src/main/java/com/xmlcalabash/library/Rename.java
  66. +1 −1 src/main/java/com/xmlcalabash/library/Replace.java
  67. +1 −1 src/main/java/com/xmlcalabash/library/SetAttributes.java
  68. +1 −1 src/main/java/com/xmlcalabash/library/Sink.java
  69. +1 −1 src/main/java/com/xmlcalabash/library/SplitSequence.java
  70. +1 −1 src/main/java/com/xmlcalabash/library/Store.java
  71. +1 −1 src/main/java/com/xmlcalabash/library/StringReplace.java
  72. +1 −1 src/main/java/com/xmlcalabash/library/Template.java
  73. +1 −1 src/main/java/com/xmlcalabash/library/UUID.java
  74. +1 −1 src/main/java/com/xmlcalabash/library/UnescapeMarkup.java
  75. +1 −1 src/main/java/com/xmlcalabash/library/Unwrap.java
  76. +1 −1 src/main/java/com/xmlcalabash/library/ValidateJing.java
  77. +1 −1 src/main/java/com/xmlcalabash/library/ValidateWithRNG.java
  78. +1 −1 src/main/java/com/xmlcalabash/library/ValidateWithSCH.java
  79. +1 −1 src/main/java/com/xmlcalabash/library/ValidateWithXSD.java
  80. +1 −1 src/main/java/com/xmlcalabash/library/WWWFormURLDecode.java
  81. +1 −1 src/main/java/com/xmlcalabash/library/WWWFormURLEncode.java
  82. +1 −1 src/main/java/com/xmlcalabash/library/Wrap.java
  83. +1 −1 src/main/java/com/xmlcalabash/library/WrapSequence.java
  84. +1 −1 src/main/java/com/xmlcalabash/library/XInclude.java
  85. +1 −1 src/main/java/com/xmlcalabash/library/XSLFormatter.java
  86. +1 −1 src/main/java/com/xmlcalabash/library/XSLT.java
  87. +1 −1 src/main/java/com/xmlcalabash/model/Binding.java
  88. +1 −1 src/main/java/com/xmlcalabash/model/Catch.java
  89. +1 −1 src/main/java/com/xmlcalabash/model/Choose.java
  90. +1 −1 src/main/java/com/xmlcalabash/model/CompoundStep.java
  91. +1 −1 src/main/java/com/xmlcalabash/model/DataBinding.java
  92. +1 −1 src/main/java/com/xmlcalabash/model/DeclareStep.java
  93. +1 −1 src/main/java/com/xmlcalabash/model/DocumentBinding.java
  94. +1 −1 src/main/java/com/xmlcalabash/model/EmptyBinding.java
  95. +1 −1 src/main/java/com/xmlcalabash/model/EndPoint.java
  96. +1 −1 src/main/java/com/xmlcalabash/model/Environment.java
  97. +1 −1 src/main/java/com/xmlcalabash/model/ErrorBinding.java
  98. +1 −1 src/main/java/com/xmlcalabash/model/ForEach.java
  99. +1 −1 src/main/java/com/xmlcalabash/model/Group.java
  100. +1 −1 src/main/java/com/xmlcalabash/model/Import.java
  101. +1 −1 src/main/java/com/xmlcalabash/model/InlineBinding.java
  102. +1 −1 src/main/java/com/xmlcalabash/model/Input.java
  103. +1 −1 src/main/java/com/xmlcalabash/model/Log.java
  104. +1 −1 src/main/java/com/xmlcalabash/model/Option.java
  105. +2 −2 src/main/java/com/xmlcalabash/model/Otherwise.java
  106. +1 −1 src/main/java/com/xmlcalabash/model/Output.java
  107. +1 −1 src/main/java/com/xmlcalabash/model/Parameter.java
  108. +1 −1 src/main/java/com/xmlcalabash/model/PipeBinding.java
  109. +1 −1 src/main/java/com/xmlcalabash/model/PipeNameBinding.java
  110. +1 −1 src/main/java/com/xmlcalabash/model/Pipeline.java
  111. +1 −1 src/main/java/com/xmlcalabash/model/PipelineLibrary.java
  112. +1 −1 src/main/java/com/xmlcalabash/model/Serialization.java
  113. +1 −1 src/main/java/com/xmlcalabash/model/SourceArtifact.java
  114. +1 −1 src/main/java/com/xmlcalabash/model/Step.java
  115. +1 −1 src/main/java/com/xmlcalabash/model/Try.java
  116. +1 −1 src/main/java/com/xmlcalabash/model/Variable.java
  117. +1 −1 src/main/java/com/xmlcalabash/model/Viewport.java
  118. +1 −1 src/main/java/com/xmlcalabash/model/When.java
  119. +1 −1 src/main/java/com/xmlcalabash/runtime/XSelect.java
  120. +8 −2 src/main/java/com/xmlcalabash/util/Base64.java
  121. +1 −2 src/main/java/com/xmlcalabash/util/Closer.java
  122. +1 −1 src/main/java/com/xmlcalabash/util/ProcessMatch.java
  123. +3 −0 src/main/java/com/xmlcalabash/util/S9apiUtils.java
  124. +1 −1 src/main/java/com/xmlcalabash/util/TreeWriter.java
  125. +1 −1 src/main/java/com/xmlcalabash/util/XProcNamespaceContext.java
  126. +8 −8 src/main/java/org/json/CDL.java
  127. +2 −2 src/main/java/org/json/Cookie.java
  128. +2 −2 src/main/java/org/json/CookieList.java
  129. +3 −3 src/main/java/org/json/HTTP.java
  130. +1 −1 src/main/java/org/json/HTTPTokener.java
  131. +4 −2 src/main/java/org/json/JSONArray.java
  132. +10 −10 src/main/java/org/json/JSONML.java
  133. +11 −11 src/main/java/org/json/JSONObject.java
  134. +8 −3 src/main/java/org/json/JSONTokener.java
  135. +3 −2 src/main/java/org/json/JSONWriter.java
  136. +1 −1 src/main/java/org/json/Test.java
  137. +14 −14 src/main/java/org/json/XML.java
  138. +10 −9 src/main/java/org/json/XMLTokener.java
@@ -39,51 +39,51 @@
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;
@@ -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.
*
@@ -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
*/
@@ -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
*/
@@ -438,7 +438,7 @@ public void setExtension(String name) {
isTargetExtensionSet = true;
}
- /**
+ /*
* Whether any errors should make the build fail.
*/
public void setFailOnError(boolean b) {
@@ -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
*/
@@ -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
*/
@@ -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
*/
@@ -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.
*/
@@ -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.
*/
@@ -75,7 +75,7 @@
private boolean debug = false;
private int chaseMemoryLeaks = 0;
- /**
+ /*
* @param args the command line arguments
*/
public static void main(String[] args) throws IOException {
@@ -96,7 +96,7 @@
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;
@@ -31,8 +31,8 @@
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);
@@ -46,7 +46,7 @@
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);
}
@@ -59,7 +59,7 @@
private Vector<ReadablePipe> options = new Vector<ReadablePipe> ();
private WritablePipe result = null;
- /**
+ /*
* Creates a new instance of Eval
*/
public Eval(XProcRuntime runtime, XAtomicStep step) {
@@ -43,7 +43,7 @@
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) {
@@ -43,7 +43,7 @@
private static final QName _value = new QName("value");
private WritablePipe result = null;
- /**
+ /*
* Creates a new instance of Identity
*/
public JavaProperties(XProcRuntime runtime, XAtomicStep step) {
@@ -33,7 +33,7 @@
private ReadablePipe source = null;
private WritablePipe result = null;
- /**
+ /*
* Creates a new instance of Identity
*/
public Message(XProcRuntime runtime, XAtomicStep step) {
@@ -47,7 +47,7 @@
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);
}
@@ -33,7 +33,7 @@
private ReadablePipe source = null;
private WritablePipe result = null;
- /**
+ /*
* Creates a new instance of NamespaceDelete
*/
public NamespaceDelete(XProcRuntime runtime, XAtomicStep step) {
@@ -37,8 +37,8 @@
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);
@@ -34,7 +34,7 @@
private TreeWriter tree = null;
private URI baseURI = null;
- /**
+ /*
* Creates a new instance of SetBaseURI
*/
public SetBaseURI(XProcRuntime runtime, XAtomicStep step) {
@@ -51,7 +51,7 @@
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) {
@@ -54,7 +54,7 @@
private ReadablePipe source = null;
private WritablePipe result = null;
- /**
+ /*
* Creates a new instance of Load
*/
public Uncompress(XProcRuntime runtime, XAtomicStep step) {
@@ -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;
@@ -65,7 +65,7 @@
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);
}
@@ -65,7 +65,7 @@
private WritablePipe result = null;
- /**
+ /*
* Creates a new instance of UriInfo
*/
public UriInfo(XProcRuntime runtime, XAtomicStep step) {
@@ -56,7 +56,7 @@
private long pauseBefore = 0;
private long pauseAfter = 0;
- /**
+ /*
* Creates a new instance of Identity
*/
public WaitForUpdate(XProcRuntime runtime, XAtomicStep step) {
@@ -108,7 +108,7 @@
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);
}
@@ -43,7 +43,7 @@
private WritablePipe result = null;
- /**
+ /*
* Creates a new instance of UriInfo
*/
public Copy(XProcRuntime runtime, XAtomicStep step) {
@@ -41,7 +41,7 @@
private WritablePipe result = null;
- /**
+ /*
* Creates a new instance of UriInfo
*/
public Delete(XProcRuntime runtime, XAtomicStep step) {
@@ -44,7 +44,7 @@
private WritablePipe result = null;
- /**
+ /*
* Creates a new instance of UriInfo
*/
public Head(XProcRuntime runtime, XAtomicStep step) {
@@ -68,7 +68,7 @@
private WritablePipe result = null;
- /**
+ /*
* Creates a new instance of UriInfo
*/
public Info(XProcRuntime runtime, XAtomicStep step) {
@@ -36,7 +36,7 @@
private WritablePipe result = null;
- /**
+ /*
* Creates a new instance of UriInfo
*/
public Mkdir(XProcRuntime runtime, XAtomicStep step) {
@@ -42,7 +42,7 @@
private WritablePipe result = null;
- /**
+ /*
* Creates a new instance of UriInfo
*/
public Move(XProcRuntime runtime, XAtomicStep step) {
Oops, something went wrong.

0 comments on commit 4be34bd

Please sign in to comment.