Site checkin for project japicmp-base

siom79 · Aug 20, 2024 · 42b634e · 42b634e
1 parent 449f4e5
commit 42b634e
Show file tree

Hide file tree

Showing 682 changed files with 31,760 additions and 11,842 deletions.
diff --git a/AntTask.html b/AntTask.html
@@ -1,13 +1,13 @@
 <!DOCTYPE html>
 <!--
- | Generated by Apache Maven Doxia Site Renderer 1.11.1 from src/site/markdown/AntTask.md at 2024-07-21
+ | Generated by Apache Maven Doxia Site Renderer 1.11.1 from src/site/markdown/AntTask.md at 2024-08-20
  | Rendered using Apache Maven Fluido Skin 1.7
 -->
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <meta name="Date-Revision-yyyymmdd" content="20240721" />
+    <meta name="Date-Revision-yyyymmdd" content="20240820" />
     <meta http-equiv="Content-Language" content="en" />
     <title>japicmp-base &#x2013; Ant Task</title>
     <link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" />
@@ -34,8 +34,8 @@
         <ul class="breadcrumb">
       <li class=""><a href="https://siom79.github.io/japicmp" class="externalLink" title="japicmp">japicmp</a><span class="divider">/</span></li>
     <li class="active ">Ant Task</li>
-        <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-07-21</li>
-          <li id="projectVersion" class="pull-right">Version: 0.22.0</li>
+        <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-08-20</li>
+          <li id="projectVersion" class="pull-right">Version: 0.23.1-SNAPSHOT</li>
         </ul>
       </div>
       <div class="row-fluid">
@@ -128,136 +128,141 @@ <h2><a name="Advanced_Usage"></a>Advanced Usage</h2>
 <td>false</td>
 <td>Indicate which part of the version to increment according to semantic versioning rules.</td></tr>
 <tr class="a">
+<td align="left">markdown</td>
+<td>true</td>
+<td>false</td>
+<td>Generates output in Markdown format.</td></tr>
+<tr class="b">
 <td align="left">onlyBinaryIncompatible</td>
 <td>true</td>
 <td>false</td>
 <td>If true, output only binary incompatible changes.</td></tr>
-<tr class="b">
+<tr class="a">
 <td align="left">onlyModified</td>
 <td>true</td>
 <td>false</td>
 <td>If true, output only modified classes/methods, else print all classes and methods.</td></tr>
-<tr class="a">
+<tr class="b">
 <td align="left">includeSynthetic</td>
 <td>true</td>
 <td>false</td>
 <td>If true, track changes for synthetic classes and class members.</td></tr>
-<tr class="b">
+<tr class="a">
 <td align="left">noAnnotations</td>
 <td>true</td>
 <td>false</td>
 <td>If true, disable the evaluation of annotations completely.</td></tr>
-<tr class="a">
+<tr class="b">
 <td align="left">reportOnlyFilename</td>
 <td>true</td>
 <td>false</td>
 <td>If true, report only filenames (not full paths).</td></tr>
-<tr class="b">
+<tr class="a">
 <td align="left">reportOnlySummary</td>
 <td>true</td>
 <td>false</td>
 <td>If true, report only a breakdown of classes and their status when generating plain text or html reports.</td></tr>
-<tr class="a">
+<tr class="b">
 <td align="left">ignoreMissingClasses</td>
 <td>true</td>
 <td>n.a.</td>
 <td>Ignore all superclasses/interfaces missing on the classpath.</td></tr>
-<tr class="b">
+<tr class="a">
 <td align="left">ignoreMissingClassesbyRegularExpressions</td>
 <td>true</td>
 <td>n.a.</td>
 <td>Ignore only those superclasses/interface missing on the classpath that are selected by a regular expression.</td></tr>
-<tr class="a">
+<tr class="b">
 <td align="left">accessModifier</td>
 <td>true</td>
 <td>protected</td>
 <td>Ignore changes below the access modifier level (public, package, protected, private).</td></tr>
-<tr class="b">
+<tr class="a">
 <td align="left">oldClassPath</td>
 <td>true</td>
 <td>n.a.</td>
 <td>Classpath for the dependencies of the old version.</td></tr>
-<tr class="a">
+<tr class="b">
 <td align="left">newClassPath</td>
 <td>true</td>
 <td>n.a.</td>
 <td>Classpath for the dependencies of the new version.</td></tr>
-<tr class="b">
+<tr class="a">
 <td align="left">oldClassPathRef</td>
 <td>true</td>
 <td>n.a.</td>
 <td>Classpath reference for the dependencies of the old version.</td></tr>
-<tr class="a">
+<tr class="b">
 <td align="left">newClassPathRef</td>
 <td>true</td>
 <td>n.a.</td>
 <td>Classpath reference for the dependencies of the new version.</td></tr>
-<tr class="b">
+<tr class="a">
 <td align="left">includes</td>
 <td>true</td>
 <td>n.a.</td>
 <td>Semicolon separated list of elements to include in the form <code>package.Class#classMember</code>, <code>*</code> can be used as wildcard. Annotations are given as FQN starting with <code>@</code>. Examples: <code>mypackage;my.Class;other.Class#method(int,long);foo.Class#field;@my.Annotation</code>.</td></tr>
-<tr class="a">
+<tr class="b">
 <td align="left">excludes</td>
 <td>true</td>
 <td>n.a.</td>
 <td>Semicolon separated list of elements to exclude in the form <code>package.Class#classMember</code>, <code>*</code> can be used as wildcard. Annotations are given as FQN starting with <code>@</code>. Examples: <code>mypackage;my.Class;other.Class#method(int,long);foo.Class#field;@my.Annotation</code>.</td></tr>
-<tr class="b">
+<tr class="a">
 <td align="left">includeExclusively</td>
 <td>true</td>
 <td>false</td>
 <td>Include only packages specified in the &#x201c;includes&#x201d; parameter, exclude their sub-packages.</td></tr>
-<tr class="a">
+<tr class="b">
 <td align="left">excludeExclusively</td>
 <td>true</td>
 <td>false</td>
 <td>Exclude only packages specified in the &#x201c;excludes&#x201d; parameter, include their sub-packages.</td></tr>
-<tr class="b">
+<tr class="a">
 <td align="left">xmlOutputFile</td>
 <td>true</td>
 <td>n.a.</td>
 <td>Path to the xml output file.</td></tr>
-<tr class="a">
+<tr class="b">
 <td align="left">htmlOutputFile</td>
 <td>true</td>
 <td>n.a.</td>
 <td>Path to the html output file.</td></tr>
-<tr class="b">
+<tr class="a">
 <td align="left">htmlStylesheet</td>
 <td>true</td>
 <td>n.a.</td>
 <td>Path to your own stylesheet.</td></tr>
-<tr class="a">
+<tr class="b">
 <td align="left">errorOnBinaryIncompatibility</td>
 <td>true</td>
 <td>false</td>
 <td>Exit with an error if a binary incompatibility is detected.</td></tr>
-<tr class="b">
+<tr class="a">
 <td align="left">errorOnSourceIncompatibility</td>
 <td>true</td>
 <td>false</td>
 <td>Exit with an error if a source incompatibility is detected.</td></tr>
-<tr class="a">
+<tr class="b">
 <td align="left">errorOnModifications</td>
 <td>true</td>
 <td>false</td>
 <td>Exit with an error if any change between versions is detected.</td></tr>
-<tr class="b">
+<tr class="a">
 <td align="left">errorOnExclusionIncompatibility</td>
 <td>true</td>
 <td>false</td>
 <td>Ignore incompatible changes caused by an excluded class.</td></tr>
-<tr class="a">
+<tr class="b">
 <td align="left">errorOnSemanticIncompatibility</td>
 <td>true</td>
 <td>false</td>
 <td>Exit with an error if the binary compatibility changes are inconsistent with Semantic Versioning. This expects versions of the form Major.Minor.Patch (e.g. 1.2.3 or 1.2.3-SNAPSHOT).</td></tr>
-<tr class="b">
+<tr class="a">
 <td align="left">ignoreMissingOldVersion</td>
 <td>true</td>
 <td>false</td>
 <td>When errorOnSemanticIncompatibility is true, ignore non-resolvable artifacts for the old version.</td></tr>
-<tr class="a">
+<tr class="b">
 <td align="left">ignoreMissingNewVersion</td>
 <td>true</td>
 <td>false</td>

diff --git a/CliTool.html b/CliTool.html
@@ -1,13 +1,13 @@
 <!DOCTYPE html>
 <!--
- | Generated by Apache Maven Doxia Site Renderer 1.11.1 from src/site/markdown/CliTool.md at 2024-07-21
+ | Generated by Apache Maven Doxia Site Renderer 1.11.1 from src/site/markdown/CliTool.md at 2024-08-20
  | Rendered using Apache Maven Fluido Skin 1.7
 -->
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <meta name="Date-Revision-yyyymmdd" content="20240721" />
+    <meta name="Date-Revision-yyyymmdd" content="20240820" />
     <meta http-equiv="Content-Language" content="en" />
     <title>japicmp-base &#x2013; CLI-Tool</title>
     <link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" />
@@ -34,8 +34,8 @@
         <ul class="breadcrumb">
       <li class=""><a href="https://siom79.github.io/japicmp" class="externalLink" title="japicmp">japicmp</a><span class="divider">/</span></li>
     <li class="active ">CLI-Tool</li>
-        <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-07-21</li>
-          <li id="projectVersion" class="pull-right">Version: 0.22.0</li>
+        <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-08-20</li>
+          <li id="projectVersion" class="pull-right">Version: 0.23.1-SNAPSHOT</li>
         </ul>
       </div>
       <div class="row-fluid">
@@ -78,6 +78,7 @@ <h1>CLI-Tool</h1>
                 [--old-classpath &lt;oldClassPath&gt;]
                 [--report-only-filename] [--report-only-summary]
                 [(-s | --semantic-versioning)]
+                [--markdown]
                 [(-x &lt;pathToXmlOutputFile&gt; | --xml-file &lt;pathToXmlOutputFile&gt;)]
                 [--error-on-binary-incompatibility]
                 [--error-on-source-incompatibility]
@@ -165,6 +166,9 @@ <h1>CLI-Tool</h1>
         -s, --semantic-versioning
             Tells you which part of the version to increment.
 
+        --markdown
+            Generates output in Markdown format.
+
         -x &lt;pathToXmlOutputFile&gt;, --xml-file &lt;pathToXmlOutputFile&gt;
             Provides the path to the xml output file.
 
@@ -201,16 +205,16 @@ <h1>CLI-Tool</h1>
 <p>When your library implements interfaces or extends classes from other libraries than the JDK and you want to evaluate binary
 compatibility you must specify the classpath for the two different versions:</p>
 
-<div class="source"><pre class="prettyprint"><code>java -jar japicmp-0.22.0-jar-with-dependencies.jar -n new-version.jar -o old-version.jar --new-classpath other-library-v2.jar
+<div class="source"><pre class="prettyprint"><code>java -jar japicmp-0.23.0-jar-with-dependencies.jar -n new-version.jar -o old-version.jar --new-classpath other-library-v2.jar
     --old-classpath other-library-v1.jar
 </code></pre></div>
 <p>In case the classpath for both versions did not change, you can add the library using the standard way:</p>
 
-<div class="source"><pre class="prettyprint"><code>java -cp japicmp-0.22.0-jar-with-dependencies.jar;otherLibrary.jar japicmp.JApiCmp -n new-version.jar -o old-version.jar
+<div class="source"><pre class="prettyprint"><code>java -cp japicmp-0.23.0-jar-with-dependencies.jar;otherLibrary.jar japicmp.JApiCmp -n new-version.jar -o old-version.jar
 </code></pre></div>
 <p>For reporting purposes you can also provide more than one jar as old or new version(s):</p>
 
-<div class="source"><pre class="prettyprint"><code>java -jar japicmp-0.22.0-jar-with-dependencies.jar -o lib1-old.jar;lib2-old.jar -n lib1-new.jar;lib2-new.jar
+<div class="source"><pre class="prettyprint"><code>java -jar japicmp-0.23.0-jar-with-dependencies.jar -o lib1-old.jar;lib2-old.jar -n lib1-new.jar;lib2-new.jar
 </code></pre></div>
         </div>
       </div>

diff --git a/Examples.html b/Examples.html
@@ -1,13 +1,13 @@
 <!DOCTYPE html>
 <!--
- | Generated by Apache Maven Doxia Site Renderer 1.11.1 from src/site/markdown/Examples.md at 2024-07-21
+ | Generated by Apache Maven Doxia Site Renderer 1.11.1 from src/site/markdown/Examples.md at 2024-08-20
  | Rendered using Apache Maven Fluido Skin 1.7
 -->
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <meta name="Date-Revision-yyyymmdd" content="20240721" />
+    <meta name="Date-Revision-yyyymmdd" content="20240820" />
     <meta http-equiv="Content-Language" content="en" />
     <title>japicmp-base &#x2013; Examples</title>
     <link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" />
@@ -34,8 +34,8 @@
         <ul class="breadcrumb">
       <li class=""><a href="https://siom79.github.io/japicmp" class="externalLink" title="japicmp">japicmp</a><span class="divider">/</span></li>
     <li class="active ">Examples</li>
-        <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-07-21</li>
-          <li id="projectVersion" class="pull-right">Version: 0.22.0</li>
+        <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-08-20</li>
+          <li id="projectVersion" class="pull-right">Version: 0.23.1-SNAPSHOT</li>
         </ul>
       </div>
       <div class="row-fluid">
@@ -90,6 +90,9 @@ <h2><a name="Comparing_two_versions_of_the_guava_library"></a>Comparing two vers
 <p>Optionally japicmp can also create an HTML report.
 An example for such a report can be found <a class="externalLink" href="http://htmlpreview.github.io/?https://github.com/siom79/japicmp/blob/master/doc/japicmp_guava.html">here</a>:</p>
 <p><img src="https://raw.github.com/siom79/japicmp/master/doc/japicmp_guava.png" alt="HTML Report" /></img></p>
+<p>At your preference, japicmp can generate a <a class="externalLink" href="https://www.markdownguide.org/">Markdown</a> report.
+You can see an example <a class="externalLink" href="https://github.com/siom79/japicmp/blob/master/doc/japicmp_guava.md">here</a>.</p>
+<p><img src="https://raw.github.com/siom79/japicmp/master/doc/japicmp_guava_markdown.png" alt="Markdown Report" /></p>
 <p>You can also let japicmp create an XML report like the following one:</p>
 
 <div class="source"><pre class="prettyprint"><code>&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot; standalone=&quot;yes&quot;?&gt;