Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The inline documentation needs attention #187

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
8 changes: 4 additions & 4 deletions src/etc/checkstyle/checkstyle-frames-sortby-check.xsl
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
<xsl:call-template name="sorted.css"/>
</redirect:write>

<!-- create the switch.js for collepsing the data -->
<!-- create the switch.js for collapsing the data -->
<redirect:write file="{$output.dir}/switch.js">
<xsl:call-template name="switch.js"/>
</redirect:write>
Expand Down Expand Up @@ -83,7 +83,7 @@


<!--
Generates the navagation bar.
Generates the navigation bar.
-->
<xsl:template match="checkstyle" mode="navigation">
<ul id="navigation">
Expand Down Expand Up @@ -167,7 +167,7 @@
<xsl:choose>
<xsl:when test="@source=$filter">
<tr>
<!-- Hide the basdir. First char of the result is a path separator so remove that. -->
<!-- Hide the basedir. First char of the result is a path separator so remove that. -->
<td><xsl:value-of select="substring(substring-after($node/@name, $basedir),2)"/></td>
<td><xsl:value-of select="@line"/></td>
<td><xsl:value-of select="@severity"/></td>
Expand Down Expand Up @@ -330,7 +330,7 @@


<!--
Calculates the index of the last occurence of a substring in a string.
Calculates the index of the last occurrence of a substring in a string.
@param txt the whole string in which to search
@delimiter the substring to search
-->
Expand Down
4 changes: 2 additions & 2 deletions src/etc/jdepend-frames.xsl
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,7 @@
</td></tr></table> -->

<xsl:if test="count(Cycles/Package) = 0">
<p>There are no cyclic dependancies.</p>
<p>There are no cyclic dependencies.</p>
</xsl:if>
<xsl:for-each select="Cycles/Package">
<h3><a><xsl:attribute name="name">#CY<xsl:value-of select="@Name"/></xsl:attribute><xsl:value-of select="@Name"/></a></h3><p>
Expand Down Expand Up @@ -373,7 +373,7 @@
<p>The range for this metric is 0 to 1, with A=0 indicating a completely concrete package and A=1 indicating a completely abstract package. </p>
<h3><a name="EXinstability">Instability</a></h3>
<p>The ratio of efferent coupling (Ce) to total coupling (Ce / (Ce + Ca)). This metric is an indicator of the package's resilience to change. </p>
<p>The range for this metric is 0 to 1, with I=0 indicating a completely stable package and I=1 indicating a completely instable package. </p>
<p>The range for this metric is 0 to 1, with I=0 indicating a completely stable package and I=1 indicating a completely unstable package. </p>
<h3><a name="EXdistance">Distance</a></h3>
<p>The perpendicular distance of a package from the idealized line A + I = 1. This metric is an indicator of the package's balance between abstractness and stability. </p>
<p>A package squarely on the main sequence is optimally balanced with respect to its abstractness and stability. Ideal packages are either completely abstract and stable (x=0, y=1) or completely concrete and instable (x=1, y=0). </p>
Expand Down
4 changes: 2 additions & 2 deletions src/etc/jdepend.xsl
Original file line number Diff line number Diff line change
Expand Up @@ -263,10 +263,10 @@
<p>The range for this metric is 0 to 1, with A=0 indicating a completely concrete package and A=1 indicating a completely abstract package. </p>
<h3><a name="EXinstability">Instability</a></h3>
<p>The ratio of efferent coupling (Ce) to total coupling (Ce / (Ce + Ca)). This metric is an indicator of the package's resilience to change. </p>
<p>The range for this metric is 0 to 1, with I=0 indicating a completely stable package and I=1 indicating a completely instable package. </p>
<p>The range for this metric is 0 to 1, with I=0 indicating a completely stable package and I=1 indicating a completely unstable package. </p>
<h3><a name="EXdistance">Distance</a></h3>
<p>The perpendicular distance of a package from the idealized line A + I = 1. This metric is an indicator of the package's balance between abstractness and stability. </p>
<p>A package squarely on the main sequence is optimally balanced with respect to its abstractness and stability. Ideal packages are either completely abstract and stable (x=0, y=1) or completely concrete and instable (x=1, y=0). </p>
<p>A package squarely on the main sequence is optimally balanced with respect to its abstractness and stability. Ideal packages are either completely abstract and stable (x=0, y=1) or completely concrete and unstable (x=1, y=0). </p>
<p>The range for this metric is 0 to 1, with D=0 indicating a package that is coincident with the main sequence and D=1 indicating a package that is as far from the main sequence as possible. </p>

</body>
Expand Down
4 changes: 2 additions & 2 deletions src/etc/junit-noframes-saxon.xsl
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@


<!-- ================================================================== -->
<!-- Write a list of all packages with an hyperlink to the anchor of -->
<!-- Write a list of all packages with a hyperlink to the anchor of -->
<!-- of the package name. -->
<!-- ================================================================== -->
<xsl:template name="packagelist">
Expand Down Expand Up @@ -485,7 +485,7 @@
<xsl:with-param name="word" select="."/>
</xsl:call-template>
</code>
<!-- the later is better but might be problematic for non-21" monitors... -->
<!-- the latter is better but might be problematic for non-21" monitors... -->
<!--pre><xsl:value-of select="."/></pre-->
</xsl:template>

Expand Down
2 changes: 1 addition & 1 deletion src/etc/junit-noframes.xsl
Original file line number Diff line number Diff line change
Expand Up @@ -449,7 +449,7 @@
<xsl:with-param name="word" select="."/>
</xsl:call-template>
</code>
<!-- the later is better but might be problematic for non-21" monitors... -->
<!-- the latter is better but might be problematic for non-21" monitors... -->
<!--pre><xsl:value-of select="."/></pre-->
</xsl:template>

Expand Down
2 changes: 1 addition & 1 deletion src/etc/maudit-frames.xsl
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
Stylesheet to transform an XML file generated by the Ant MAudit task into
a set of JavaDoc-like HTML page to make pages more convenient to be browsed.

It use the Xalan redirect extension to write to multiple output files.
It uses the Xalan redirect extension to write to multiple output files.

-->

Expand Down
10 changes: 5 additions & 5 deletions src/etc/mmetrics-frames.xsl
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@
</xsl:for-each>
</xsl:template>

<!-- little trick to compute the classname for inner and non inner classes -->
<!-- little trick to compute the classname for inner and non-inner classes -->
<!-- this is all in one line to avoid CRLF in the name -->
<xsl:template match="class" mode="class.name">
<xsl:if test="parent::class"><xsl:apply-templates select="parent::class" mode="class.name"/>.<xsl:value-of select="@name"/></xsl:if><xsl:if test="not(parent::class)"><xsl:value-of select="@name"/></xsl:if>
Expand Down Expand Up @@ -268,15 +268,15 @@ invocation of a method that is not declared in any of:
<li>a class or method that extends the class.</li>
</ul>

The value is the count of all the remote method calls in all of the methods
The value is the count of all the remote method calls in all the methods
and constructors of the class.

<a name="NLM"/>
<h3>Number of Local Methods - NLM</h3>

NLM is defined for classes and interfaces. A local method is defined as a
method that is declared in the class or interface. NLM can be configured to
include the local methods of all of the class's superclasses. Methods with
include the local methods of all the class's superclasses. Methods with
public, protected, package and private visibility can be independently
counted by setting configuration parameters.

Expand Down Expand Up @@ -324,7 +324,7 @@ typically require a deeper understanding of the potential interactions that
objects of the class can have with the rest of the system.
<p/>
RFC is defined as the sum of NLM and NRM for the class. The local methods
include all of the public, protected, package and private methods, but not
include all the public, protected, package and private methods, but not
methods declared only in a superclass.

<a name="DAC"/>
Expand Down Expand Up @@ -399,7 +399,7 @@ If a class exhibits low method cohesion it indicates that the design of the
class has probably been partitioned incorrectly, and could benefit by being
split into more classes with individually higher cohesion. On the other
hand, a high value of cohesion (a low lack of cohesion) implies that the
class is well designed. A cohesive class will tend to provide a high degree
class is well-designed. A cohesive class will tend to provide a high degree
of encapsulation, whereas a lack of cohesion decreases encapsulation and
increases complexity.
<p/>
Expand Down
4 changes: 2 additions & 2 deletions src/etc/testcases/taskdefs/exec/exec.xml
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@

<target name="setUp">
<mkdir dir="${output}"/>
<!-- this property can be overriden programatically in the Java test case -->
<!-- this property can be overridden programmatically in the Java test case -->
<property name="timeToWait" value="10"/>
<!-- this property can be overriden programatically in the Java test case -->
<!-- this property can be overridden programatically in the Java test case -->
<property name="logFile" value="${output}/spawn.log"/>
<property environment="env"/>
<!-- UNIX -->
Expand Down
4 changes: 2 additions & 2 deletions src/etc/testcases/taskdefs/jmod.xml
Original file line number Diff line number Diff line change
Expand Up @@ -720,7 +720,7 @@ Change the user\*(Aqs office phone number\&.
.PP
If none of the options are selected,
\fBchfn\fR
operates in an interactive fashion, prompting the user with the current values for all of the fields\&. Enter the new value to change the field, or leave the line blank to use the current value\&. The current value is displayed between a pair of
operates in an interactive fashion, prompting the user with the current values for all the fields\&. Enter the new value to change the field, or leave the line blank to use the current value\&. The current value is displayed between a pair of
\fB[ ]\fR
marks\&. Without options,
\fBchfn\fR
Expand Down Expand Up @@ -1135,7 +1135,7 @@ Change the user\*(Aqs office phone number\&.
.PP
If none of the options are selected,
\fBchfn\fR
operates in an interactive fashion, prompting the user with the current values for all of the fields\&. Enter the new value to change the field, or leave the line blank to use the current value\&. The current value is displayed between a pair of
operates in an interactive fashion, prompting the user with the current values for all the fields\&. Enter the new value to change the field, or leave the line blank to use the current value\&. The current value is displayed between a pair of
\fB[ ]\fR
marks\&. Without options,
\fBchfn\fR
Expand Down
2 changes: 1 addition & 1 deletion src/etc/testcases/taskdefs/link.xml
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ Change the user\*(Aqs office phone number\&.
.PP
If none of the options are selected,
\fBchfn\fR
operates in an interactive fashion, prompting the user with the current values for all of the fields\&. Enter the new value to change the field, or leave the line blank to use the current value\&. The current value is displayed between a pair of
operates in an interactive fashion, prompting the user with the current values for all the fields\&. Enter the new value to change the field, or leave the line blank to use the current value\&. The current value is displayed between a pair of
\fB[ ]\fR
marks\&. Without options,
\fBchfn\fR
Expand Down
2 changes: 1 addition & 1 deletion src/etc/testcases/taskdefs/optional/antlr/java.g
Original file line number Diff line number Diff line change
Expand Up @@ -442,7 +442,7 @@ parameterModifier
// Inside a class definition without "static":
// it is an instance initializer
// As the body of a method
// As a completely indepdent braced block of code inside a method
// As a completely independent braced block of code inside a method
// it starts a new scope for variable definitions

compoundStatement
Expand Down
6 changes: 3 additions & 3 deletions src/etc/testcases/taskdefs/optional/unix/symlink.xml
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@
<!--

/*
* Since the initial version of this file was deveolped on the clock on
* Since the initial version of this file was developed on the clock on
* an NSF grant I should say the following boilerplate:
*
* This material is based upon work supported by the National Science
* Foundaton under Grant No. EIA-0196404. Any opinions, findings, and
* Foundation under Grant No. EIA-0196404. Any opinions, findings, and
* conclusions or recommendations expressed in this material are those
* of the author and do not necessarily reflect the views of the
* National Science Foundation.
Expand All @@ -41,7 +41,7 @@
catch up before executing a task that depends on the
completion of previous tasks. This delay is also added to
the end of each target so junit doesn't go testing things
before they have finnished (hopefully). Tweak if needed.
before they have finished (hopefully). Tweak if needed.
-->

<property name="delay" value="0"/>
Expand Down
4 changes: 2 additions & 2 deletions src/etc/testcases/types/assertions.xml
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@
</java>
</target>

<!-- repeated settigns result in the last declaration winning
<!-- repeated settings result in the last declaration winning
except that the rule 'classes win over packages takes priority
this run will assert -->
<target name="test-override" depends="setUp">
Expand All @@ -99,7 +99,7 @@
</java>
</target>

<!-- repeated settigns result in the last declaration winning;
<!-- repeated settings result in the last declaration winning;
this run will not assert -->
<target name="test-override2" depends="setUp">
<java fork="true" failonerror="true"
Expand Down
30 changes: 15 additions & 15 deletions src/main/org/apache/tools/ant/AntClassLoader.java
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ private void findNextResource() {
private final Vector<String> loaderPackages = new Vector<>();

/**
* Whether or not this classloader will ignore the base
* Whether this classloader will ignore the base
* classloader if it can't find a class.
*
* @see #setIsolated(boolean)
Expand Down Expand Up @@ -259,7 +259,7 @@ private void findNextResource() {
private ClassLoader savedContextLoader = null;

/**
* Whether or not the context loader is currently saved.
* Whether the context loader is currently saved.
*/
private boolean isContextLoaderSaved = false;

Expand Down Expand Up @@ -316,7 +316,7 @@ public AntClassLoader(final Project project, final Path classpath) {
* elements are set up to start with.
* @param parentFirst If <code>true</code>, indicates that the parent
* classloader should be consulted before trying to
* load the a class through this loader.
* load the class through this loader.
*/
public AntClassLoader(final ClassLoader parent, final Project project,
final Path classpath, final boolean parentFirst) {
Expand All @@ -338,7 +338,7 @@ public AntClassLoader(final ClassLoader parent, final Project project,
* elements are set up to start with.
* @param parentFirst If <code>true</code>, indicates that the parent
* classloader should be consulted before trying to
* load the a class through this loader.
* load the class through this loader.
*/
public AntClassLoader(final Project project, final Path classpath,
final boolean parentFirst) {
Expand All @@ -356,7 +356,7 @@ public AntClassLoader(final Project project, final Path classpath,
* class is used as the parent.
* @param parentFirst If <code>true</code>, indicates that the parent
* classloader should be consulted before trying to
* load the a class through this loader.
* load the class through this loader.
*/
public AntClassLoader(final ClassLoader parent, final boolean parentFirst) {
setParent(parent);
Expand Down Expand Up @@ -581,7 +581,7 @@ public String getClasspath() {
* not be referred to the parent class loader but will cause a
* ClassNotFoundException.
*
* @param isolated Whether or not this classloader should run in
* @param isolated Whether this classloader should run in
* isolated mode.
*/
public synchronized void setIsolated(final boolean isolated) {
Expand Down Expand Up @@ -830,7 +830,7 @@ private InputStream getResourceStream(final File file, final String resourceName
}

/**
* Tests whether or not the parent classloader should be checked for a
* Tests whether the parent classloader should be checked for a
* resource before this one. If the resource matches both the "use parent
* classloader first" and the "use this classloader first" lists, the latter
* takes priority.
Expand All @@ -839,7 +839,7 @@ private InputStream getResourceStream(final File file, final String resourceName
* The name of the resource to check. Must not be
* <code>null</code>.
*
* @return whether or not the parent classloader should be checked for a
* @return whether the parent classloader should be checked for a
* resource before this one is.
*/
private boolean isParentFirst(final String resourceName) {
Expand Down Expand Up @@ -868,7 +868,7 @@ private ClassLoader getRootLoader() {

/**
* Finds the resource with the given name. A resource is
* some data (images, audio, text, etc) that can be accessed by class
* some data (images, audio, text, etc.) that can be accessed by class
* code in a way that is independent of the location of the code.
*
* @param name The name of the resource for which a stream is required.
Expand All @@ -892,7 +892,7 @@ public URL getResource(final String name) {
url = getUrl(name);
}
if (url == null && !isParentFirst(name)) {
// this loader was first but it didn't find it - try the parent
// this loader was first, but it didn't find it - try the parent
if (ignoreBase) {
url = getRootLoader() == null ? null : getRootLoader().getResource(name);
} else {
Expand Down Expand Up @@ -933,7 +933,7 @@ private URL getUrl(String name) {

/**
* Finds all the resources with the given name. A resource is some
* data (images, audio, text, etc) that can be accessed by class
* data (images, audio, text, etc.) that can be accessed by class
* code in a way that is independent of the location of the code.
*
* @param name name of the resource
Expand Down Expand Up @@ -1076,7 +1076,7 @@ protected URL getResourceURL(final File file, final String resourceName) {
* Loads a class with this class loader.
*
* This class attempts to load the class in an order determined by whether
* or not the class matches the system/loader package lists, with the
* the class matches the system/loader package lists, with the
* loader package list taking priority. If the classloader is in isolated
* mode, failure to load the class in this loader will result in a
* ClassNotFoundException.
Expand Down Expand Up @@ -1204,12 +1204,12 @@ protected void definePackage(final File container, final String className) throw
}

/**
* Get the manifest from the given jar, if it is indeed a jar and it has a
* Get the manifest from the given jar, if it is indeed a jar, and it has a
* manifest
*
* @param container the File from which a manifest is required.
*
* @return the jar's manifest or null is the container is not a jar or it
* @return the jar's manifest or null is the container is not a jar, or it
* has no manifest.
*
* @exception IOException if the manifest cannot be read.
Expand All @@ -1232,7 +1232,7 @@ private Manifest getJarManifest(final File container) throws IOException {
* @param entry the entry of which the certificates are requested
*
* @return the entry's certificates or null is the container is
* not a jar or it has no certificates.
* not a jar, or it has no certificates.
*/
private Certificate[] getCertificates(final File container, final String entry) {
if (container.isDirectory()) {
Expand Down
2 changes: 1 addition & 1 deletion src/main/org/apache/tools/ant/AntTypeDefinition.java
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ public String getName() {

/**
* Set the class of the definition.
* As a side-effect may set the classloader and classname.
* As a side effect may set the classloader and classname.
* @param clazz the class of this definition.
*/
public void setClass(Class<?> clazz) {
Expand Down
2 changes: 1 addition & 1 deletion src/main/org/apache/tools/ant/ArgumentProcessor.java
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
* <p>
* Arguments supported by third party code should not conflict with Ant core
* ones. It is then recommended to chose specific 'enough' argument name,
* avoiding for instance one letter arguments. By the way, if there any
* avoiding for instance one letter arguments. By the way, if there is any
* conflict, Ant will take precedence.
*
* @since 1.9
Expand Down
Loading