Typo: 'JavaDoc' -> 'Javadoc'. master
authorGary Gregory <garydgregory@gmail.com>
Tue, 15 May 2018 19:07:32 +0000 (13:07 -0600)
committerGary Gregory <garydgregory@gmail.com>
Tue, 15 May 2018 19:07:32 +0000 (13:07 -0600)
README.md
src/site/xdoc/index.xml

index 1b18183..fa0d1a1 100644 (file)
--- a/README.md
+++ b/README.md
-<!---\r
- Licensed to the Apache Software Foundation (ASF) under one or more\r
- contributor license agreements.  See the NOTICE file distributed with\r
- this work for additional information regarding copyright ownership.\r
- The ASF licenses this file to You under the Apache License, Version 2.0\r
- (the "License"); you may not use this file except in compliance with\r
- the License.  You may obtain a copy of the License at\r
-\r
-      http://www.apache.org/licenses/LICENSE-2.0\r
-\r
- Unless required by applicable law or agreed to in writing, software\r
- distributed under the License is distributed on an "AS IS" BASIS,\r
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
- See the License for the specific language governing permissions and\r
- limitations under the License.\r
--->\r
-<!---\r
- +======================================================================+\r
- |****                                                              ****|\r
- |****      THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN      ****|\r
- |****                    DO NOT EDIT DIRECTLY                      ****|\r
- |****                                                              ****|\r
- +======================================================================+\r
- | TEMPLATE FILE: readme-md-template.md                                 |\r
- | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |\r
- +======================================================================+\r
- |                                                                      |\r
- | 1) Re-generate using: mvn commons:readme-md                          |\r
- |                                                                      |\r
- | 2) Set the following properties in the component's pom:              |\r
- |    - commons.componentid (required, alphabetic, lower case)          |\r
- |    - commons.release.version (required)                              |\r
- |                                                                      |\r
- | 3) Example Properties                                                |\r
- |                                                                      |\r
- |  <properties>                                                        |\r
- |    <commons.componentid>math</commons.componentid>                   |\r
- |    <commons.release.version>1.2</commons.release.version>            |\r
- |  </properties>                                                       |\r
- |                                                                      |\r
- +======================================================================+\r
---->\r
-Apache Commons Testing Parent POM\r
-===================\r
-\r
-[![Build Status](https://travis-ci.org/apache/commons-testing-parent.svg?branch=master)](https://travis-ci.org/apache/commons-testing-parent)\r
-[![Coverage Status](https://coveralls.io/repos/apache/commons-testing-parent/badge.svg?branch=master)](https://coveralls.io/r/apache/commons-testing-parent)\r
-[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-testing-parent/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-testing-parent/)\r
-[![License](http://img.shields.io/:license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)\r
-\r
-Apache Commons Testing, a package of Java utility classes for testing.\r
-\r
-Documentation\r
--------------\r
-\r
-More information can be found on the [Apache Commons Testing Parent POM homepage](https://commons.apache.org/proper/commons-testing).\r
-The [JavaDoc](https://commons.apache.org/proper/commons-testing/javadocs/api-release) can be browsed.\r
-Questions related to the usage of Apache Commons Testing Parent POM should be posted to the [user mailing list][ml].\r
-\r
-Where can I get the latest release?\r
------------------------------------\r
-You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-testing/download_testing.cgi).\r
-\r
-Alternatively you can pull it from the central Maven repositories:\r
-\r
-```xml\r
-<dependency>\r
-  <groupId>org.apache.commons</groupId>\r
-  <artifactId>commons-testing-parent</artifactId>\r
-  <version>1.0.0</version>\r
-</dependency>\r
-```\r
-\r
-Contributing\r
-------------\r
-\r
-We accept Pull Requests via GitHub. The [developer mailing list][ml] is the main channel of communication for contributors.\r
-There are some guidelines which will make applying PRs easier for us:\r
-+ No tabs! Please use spaces for indentation.\r
-+ Respect the code style.\r
-+ Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted create a separate PR for this change.\r
-+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running ```mvn clean test```.\r
-\r
-If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas).\r
-You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md).\r
-\r
-License\r
--------\r
-This code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0).\r
-\r
-See the `NOTICE.txt` file for required notices and attributions.\r
-\r
-Donations\r
----------\r
-You like Apache Commons Testing Parent POM? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.\r
-\r
-Additional Resources\r
---------------------\r
-\r
-+ [Apache Commons Homepage](https://commons.apache.org/)\r
-+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/TESTING)\r
-+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)\r
-+ `#apache-commons` IRC channel on `irc.freenode.org`\r
-\r
-[ml]:https://commons.apache.org/mail-lists.html\r
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<!---
+ +======================================================================+
+ |****                                                              ****|
+ |****      THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN      ****|
+ |****                    DO NOT EDIT DIRECTLY                      ****|
+ |****                                                              ****|
+ +======================================================================+
+ | TEMPLATE FILE: readme-md-template.md                                 |
+ | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+ +======================================================================+
+ |                                                                      |
+ | 1) Re-generate using: mvn commons:readme-md                          |
+ |                                                                      |
+ | 2) Set the following properties in the component's pom:              |
+ |    - commons.componentid (required, alphabetic, lower case)          |
+ |    - commons.release.version (required)                              |
+ |                                                                      |
+ | 3) Example Properties                                                |
+ |                                                                      |
+ |  <properties>                                                        |
+ |    <commons.componentid>math</commons.componentid>                   |
+ |    <commons.release.version>1.2</commons.release.version>            |
+ |  </properties>                                                       |
+ |                                                                      |
+ +======================================================================+
+--->
+Apache Commons Testing Parent POM
+===================
+
+[![Build Status](https://travis-ci.org/apache/commons-testing-parent.svg?branch=master)](https://travis-ci.org/apache/commons-testing-parent)
+[![Coverage Status](https://coveralls.io/repos/apache/commons-testing-parent/badge.svg?branch=master)](https://coveralls.io/r/apache/commons-testing-parent)
+[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-testing-parent/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-testing-parent/)
+[![License](http://img.shields.io/:license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)
+
+Apache Commons Testing, a package of Java utility classes for testing.
+
+Documentation
+-------------
+
+More information can be found on the [Apache Commons Testing Parent POM homepage](https://commons.apache.org/proper/commons-testing).
+The [Javadoc](https://commons.apache.org/proper/commons-testing/javadocs/api-release) can be browsed.
+Questions related to the usage of Apache Commons Testing Parent POM should be posted to the [user mailing list][ml].
+
+Where can I get the latest release?
+-----------------------------------
+You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-testing/download_testing.cgi).
+
+Alternatively you can pull it from the central Maven repositories:
+
+```xml
+<dependency>
+  <groupId>org.apache.commons</groupId>
+  <artifactId>commons-testing-parent</artifactId>
+  <version>1.0.0</version>
+</dependency>
+```
+
+Contributing
+------------
+
+We accept Pull Requests via GitHub. The [developer mailing list][ml] is the main channel of communication for contributors.
+There are some guidelines which will make applying PRs easier for us:
++ No tabs! Please use spaces for indentation.
++ Respect the code style.
++ Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted create a separate PR for this change.
++ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running ```mvn clean test```.
+
+If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas).
+You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md).
+
+License
+-------
+This code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0).
+
+See the `NOTICE.txt` file for required notices and attributions.
+
+Donations
+---------
+You like Apache Commons Testing Parent POM? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
+
+Additional Resources
+--------------------
+
++ [Apache Commons Homepage](https://commons.apache.org/)
++ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/TESTING)
++ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
++ `#apache-commons` IRC channel on `irc.freenode.org`
+
+[ml]:https://commons.apache.org/mail-lists.html
index fccee90..5e6aef9 100644 (file)
-<?xml version="1.0"?>\r
-<!--\r
-  Licensed to the Apache Software Foundation (ASF) under one or more\r
-  contributor license agreements. See the NOTICE file distributed with\r
-  this work for additional information regarding copyright ownership.\r
-  The ASF licenses this file to You under the Apache License, Version 2.0\r
-  (the "License"); you may not use this file except in compliance with\r
-  the License. You may obtain a copy of the License at\r
-\r
-  http://www.apache.org/licenses/LICENSE-2.0\r
-\r
-  Unless required by applicable law or agreed to in writing, software\r
-  distributed under the License is distributed on an "AS IS" BASIS,\r
-  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
-  See the License for the specific language governing permissions and\r
-  limitations under the License.\r
--->\r
-<document>\r
-  <properties>\r
-    <title>Home</title>\r
-    <author email="dev@commons.apache.org">Commons Documentation Team</author>\r
-  </properties>\r
-  <body>\r
-    <!-- ================================================== -->\r
-    <section name="Apache Commons Testing">\r
-      <p>\r
-        <em>Apache Commons Testing</em>\r
-        is a multi-module project focused on providing code for testing applications\r
-        using various testing frameworks with an initial focus on JUnit 4.\r
-      </p>\r
-    </section>\r
-    <!-- ================================================== -->\r
-    <section name="Documentation">\r
-      <p>\r
-        The package descriptions in the\r
-        <a href="javadocs/api-release/index.html">JavaDoc</a>\r
-        give an overview of the available features\r
-        and various\r
-        <a href="project-reports.html">project reports</a>\r
-        are provided.\r
-      </p>\r
-      <p>\r
-        The JavaDoc API documents are available online:\r
-      </p>\r
-      <ul>\r
-        <li>\r
-          The\r
-          <a href="javadocs/api-1.0.0/index.html">current stable release 1.0.0</a>\r
-          [Java 7]\r
-        </li>\r
-      </ul>\r
-      <p>\r
-        The\r
-        <a href="source-repository.html">git repository</a>\r
-        can be\r
-        <a href="https://git-wip-us.apache.org/repos/asf?p=commons-testing.git">browsed</a>\r
-        , or you can browse/contribute via\r
-        <a href="https://github.com/apache/commons-testing">GitHub</a>\r
-        .\r
-      </p>\r
-    </section>\r
-    <!-- ================================================== -->\r
-    <section name="Release Information">\r
-      <p>The latest stable release of Lang is 1.0.0. You may: </p>\r
-      <ul>\r
-        <li>\r
-          Download\r
-          <a href="http://commons.apache.org/lang/download_lang.cgi">1.0.0</a>\r
-        </li>\r
-        <li>\r
-          Read the\r
-          <a href="RELEASE-NOTES.txt">1.0.0 release notes</a>\r
-        </li>\r
-      </ul>\r
-      <p>\r
-        Alternatively you can pull various artifacts it from the central Maven repository:\r
-      </p>\r
-      <ul>\r
-        <li>\r
-          <a href="generic/dependency-info.html">Apache Commons Testing Generic</a>\r
-        </li>\r
-        <li>\r
-          <a href="junit4/dependency-info.html">Apache Commons Testing for JUnit 4</a>\r
-        </li>\r
-        <li>\r
-          <a href="junit4-mongodb/dependency-info.html">Apache Commons Testing for JUnit 4 for MongoDB</a>\r
-        </li>\r
-      </ul>\r
-      <p>\r
-        For information on previous releases see the\r
-        <a href="release-history.html">Release History</a>\r
-        , and to download previous releases see the\r
-        <a href="http://archive.apache.org/dist/commons/testing/">Commons Testing Archive</a>\r
-        .\r
-      </p>\r
-    </section>\r
-    <!-- ================================================== -->\r
-    <section name="Getting Involved">\r
-      <p>\r
-        The\r
-        <a href="mail-lists.html">commons developer mailing list</a>\r
-        is the main channel of communication for contributors. Please remember that the lists are shared between all\r
-        commons components, so prefix your email by [testing].\r
-      </p>\r
-      <p>\r
-        You can also visit the #apache-commons IRC channel on irc.freenode.net or peruse\r
-        <a href="issue-tracking.html">JIRA</a>\r
-        . Specific links of interest for JIRA are:\r
-      </p>\r
-      <ul>\r
-        <li>\r
-          Ideas looking for code:\r
-          <a\r
-            href="https://issues.apache.org/jira/issues/?jql=project%20%3D%20TESTING%20AND%20resolution%20%3D%20Unresolved%20AND%20fixVersion%20%3D%20%22Patch%20Needed%22%20ORDER%20BY%20priority%20DESC">Patch Needed</a>\r
-        </li>\r
-        <li>\r
-          Issues with patches, looking for reviews:\r
-          <a\r
-            href="https://issues.apache.org/jira/issues/?jql=fixVersion%20%3D%20%22Review%20Patch%22%20AND%20project%20%3D%20TESTING%20AND%20resolution%20%3D%20Unresolved%20ORDER%20BY%20priority%20DESC">Review Patch</a>\r
-        </li>\r
-      </ul>\r
-      <p>\r
-        Alternatively you can go through the\r
-        <em>Needs Work</em>\r
-        tags in the\r
-        <a href="taglist.html">TagList report</a>\r
-        .\r
-      </p>\r
-      <p>\r
-        If you'd like to offer up pull requests via GitHub rather than applying patches to JIRA, we have a\r
-        <a href="https://github.com/apache/commons-testing/">GitHub mirror</a>\r
-        .\r
-      </p>\r
-    </section>\r
-    <!-- ================================================== -->\r
-    <section name="Support">\r
-      <p>\r
-        The\r
-        <a href="mail-lists.html">commons mailing lists</a>\r
-        act as the main support forum.\r
-        The user list is suitable for most library usage queries.\r
-        The dev list is intended\r
-        for the development discussion.\r
-        Please remember that the lists are shared between all commons components,\r
-        so\r
-        prefix your email by [testing].\r
-      </p>\r
-      <p>\r
-        Bug reports and enhancements are also welcomed via the\r
-        <a href="issue-tracking.html">JIRA</a>\r
-        issue tracker.\r
-        Please read the instructions carefully.\r
-      </p>\r
-    </section>\r
-    <!-- ================================================== -->\r
-  </body>\r
-</document>\r
+<?xml version="1.0"?>
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements. See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License. You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<document>
+  <properties>
+    <title>Home</title>
+    <author email="dev@commons.apache.org">Commons Documentation Team</author>
+  </properties>
+  <body>
+    <!-- ================================================== -->
+    <section name="Apache Commons Testing">
+      <p>
+        <em>Apache Commons Testing</em>
+        is a multi-module project focused on providing code for testing applications
+        using various testing frameworks with an initial focus on JUnit 4.
+      </p>
+    </section>
+    <!-- ================================================== -->
+    <section name="Documentation">
+      <p>
+        The package descriptions in the
+        <a href="javadocs/api-release/index.html">Javadoc</a>
+        give an overview of the available features
+        and various
+        <a href="project-reports.html">project reports</a>
+        are provided.
+      </p>
+      <p>
+        The Javadoc API documents are available online:
+      </p>
+      <ul>
+        <li>
+          The
+          <a href="javadocs/api-1.0.0/index.html">current stable release 1.0.0</a>
+          [Java 7]
+        </li>
+      </ul>
+      <p>
+        The
+        <a href="source-repository.html">git repository</a>
+        can be
+        <a href="https://git-wip-us.apache.org/repos/asf?p=commons-testing.git">browsed</a>
+        , or you can browse/contribute via
+        <a href="https://github.com/apache/commons-testing">GitHub</a>
+        .
+      </p>
+    </section>
+    <!-- ================================================== -->
+    <section name="Release Information">
+      <p>The latest stable release of Lang is 1.0.0. You may: </p>
+      <ul>
+        <li>
+          Download
+          <a href="http://commons.apache.org/lang/download_lang.cgi">1.0.0</a>
+        </li>
+        <li>
+          Read the
+          <a href="RELEASE-NOTES.txt">1.0.0 release notes</a>
+        </li>
+      </ul>
+      <p>
+        Alternatively you can pull various artifacts it from the central Maven repository:
+      </p>
+      <ul>
+        <li>
+          <a href="generic/dependency-info.html">Apache Commons Testing Generic</a>
+        </li>
+        <li>
+          <a href="junit4/dependency-info.html">Apache Commons Testing for JUnit 4</a>
+        </li>
+        <li>
+          <a href="junit4-mongodb/dependency-info.html">Apache Commons Testing for JUnit 4 for MongoDB</a>
+        </li>
+      </ul>
+      <p>
+        For information on previous releases see the
+        <a href="release-history.html">Release History</a>
+        , and to download previous releases see the
+        <a href="http://archive.apache.org/dist/commons/testing/">Commons Testing Archive</a>
+        .
+      </p>
+    </section>
+    <!-- ================================================== -->
+    <section name="Getting Involved">
+      <p>
+        The
+        <a href="mail-lists.html">commons developer mailing list</a>
+        is the main channel of communication for contributors. Please remember that the lists are shared between all
+        commons components, so prefix your email by [testing].
+      </p>
+      <p>
+        You can also visit the #apache-commons IRC channel on irc.freenode.net or peruse
+        <a href="issue-tracking.html">JIRA</a>
+        . Specific links of interest for JIRA are:
+      </p>
+      <ul>
+        <li>
+          Ideas looking for code:
+          <a
+            href="https://issues.apache.org/jira/issues/?jql=project%20%3D%20TESTING%20AND%20resolution%20%3D%20Unresolved%20AND%20fixVersion%20%3D%20%22Patch%20Needed%22%20ORDER%20BY%20priority%20DESC">Patch Needed</a>
+        </li>
+        <li>
+          Issues with patches, looking for reviews:
+          <a
+            href="https://issues.apache.org/jira/issues/?jql=fixVersion%20%3D%20%22Review%20Patch%22%20AND%20project%20%3D%20TESTING%20AND%20resolution%20%3D%20Unresolved%20ORDER%20BY%20priority%20DESC">Review Patch</a>
+        </li>
+      </ul>
+      <p>
+        Alternatively you can go through the
+        <em>Needs Work</em>
+        tags in the
+        <a href="taglist.html">TagList report</a>
+        .
+      </p>
+      <p>
+        If you'd like to offer up pull requests via GitHub rather than applying patches to JIRA, we have a
+        <a href="https://github.com/apache/commons-testing/">GitHub mirror</a>
+        .
+      </p>
+    </section>
+    <!-- ================================================== -->
+    <section name="Support">
+      <p>
+        The
+        <a href="mail-lists.html">commons mailing lists</a>
+        act as the main support forum.
+        The user list is suitable for most library usage queries.
+        The dev list is intended
+        for the development discussion.
+        Please remember that the lists are shared between all commons components,
+        so
+        prefix your email by [testing].
+      </p>
+      <p>
+        Bug reports and enhancements are also welcomed via the
+        <a href="issue-tracking.html">JIRA</a>
+        issue tracker.
+        Please read the instructions carefully.
+      </p>
+    </section>
+    <!-- ================================================== -->
+  </body>
+</document>