Skip to content

Commit

Permalink
Deploying to gh-pages from @ ca7a58b 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
goneall committed Jan 19, 2024
1 parent 3079c7b commit 3058d95
Show file tree
Hide file tree
Showing 16 changed files with 325 additions and 48 deletions.
18 changes: 10 additions & 8 deletions apidocs/allclasses-index.html
Original file line number Diff line number Diff line change
Expand Up @@ -134,20 +134,22 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Builds SPDX documents for a given set of source files.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/spdx/maven/utils/SpdxFileCollector.html" title="class in org.spdx.maven.utils">SpdxFileCollector</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/spdx/maven/utils/SpdxExternalRefBuilder.html" title="class in org.spdx.maven.utils">SpdxExternalRefBuilder</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/spdx/maven/utils/SpdxFileCollector.html" title="class in org.spdx.maven.utils">SpdxFileCollector</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Collects SPDX file information from directories.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/spdx/maven/utils/SpdxProjectInformation.html" title="class in org.spdx.maven.utils">SpdxProjectInformation</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/spdx/maven/utils/SpdxProjectInformation.html" title="class in org.spdx.maven.utils">SpdxProjectInformation</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Simple structure to hold information about SPDX project</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/spdx/maven/utils/SpdxSourceFileParser.html" title="class in org.spdx.maven.utils">SpdxSourceFileParser</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/spdx/maven/utils/SpdxSourceFileParser.html" title="class in org.spdx.maven.utils">SpdxSourceFileParser</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Helper class with static methods to parse SPDX source files</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab5"><a href="org/spdx/maven/utils/SpdxSourceParserException.html" title="class in org.spdx.maven.utils">SpdxSourceParserException</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab5">
<div class="col-first even-row-color all-classes-table all-classes-table-tab5"><a href="org/spdx/maven/utils/SpdxSourceParserException.html" title="class in org.spdx.maven.utils">SpdxSourceParserException</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab5">
<div class="block">Exceptions related to parsing source files for SPDX identifiers</div>
</div>
</div>
Expand Down
10 changes: 8 additions & 2 deletions apidocs/index-all.html
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,8 @@ <h2 class="title" id="I:G">G</h2>
<dd>&nbsp;</dd>
<dt><a href="org/spdx/maven/utils/SpdxProjectInformation.html#getDeclaredLicense()" class="member-name-link">getDeclaredLicense()</a> - Method in class org.spdx.maven.utils.<a href="org/spdx/maven/utils/SpdxProjectInformation.html" title="class in org.spdx.maven.utils">SpdxProjectInformation</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/spdx/maven/utils/SpdxExternalRefBuilder.html#getDefaultExternalRefs(org.spdx.library.model.SpdxDocument,boolean,org.apache.maven.project.MavenProject)" class="member-name-link">getDefaultExternalRefs(SpdxDocument, boolean, MavenProject)</a> - Static method in class org.spdx.maven.utils.<a href="org/spdx/maven/utils/SpdxExternalRefBuilder.html" title="class in org.spdx.maven.utils">SpdxExternalRefBuilder</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/spdx/maven/PathSpecificSpdxInfo.html#getDefaultFileInformation(org.spdx.maven.utils.SpdxDefaultFileInformation,org.spdx.library.model.SpdxDocument)" class="member-name-link">getDefaultFileInformation(SpdxDefaultFileInformation, SpdxDocument)</a> - Method in class org.spdx.maven.<a href="org/spdx/maven/PathSpecificSpdxInfo.html" title="class in org.spdx.maven">PathSpecificSpdxInfo</a></dt>
<dd>
<div class="block">Get the default file information to be used with this file path</div>
Expand Down Expand Up @@ -590,13 +592,17 @@ <h2 class="title" id="I:S">S</h2>
<dd>
<div class="block">Contains information about package dependencies collected from the Maven dependencies.</div>
</dd>
<dt><a href="org/spdx/maven/utils/SpdxDependencyInformation.html#%3Cinit%3E(org.spdx.maven.utils.LicenseManager,org.spdx.library.model.SpdxDocument,boolean)" class="member-name-link">SpdxDependencyInformation(LicenseManager, SpdxDocument, boolean)</a> - Constructor for class org.spdx.maven.utils.<a href="org/spdx/maven/utils/SpdxDependencyInformation.html" title="class in org.spdx.maven.utils">SpdxDependencyInformation</a></dt>
<dt><a href="org/spdx/maven/utils/SpdxDependencyInformation.html#%3Cinit%3E(org.spdx.maven.utils.LicenseManager,org.spdx.library.model.SpdxDocument,boolean,boolean)" class="member-name-link">SpdxDependencyInformation(LicenseManager, SpdxDocument, boolean, boolean)</a> - Constructor for class org.spdx.maven.utils.<a href="org/spdx/maven/utils/SpdxDependencyInformation.html" title="class in org.spdx.maven.utils">SpdxDependencyInformation</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/spdx/maven/utils/SpdxDocumentBuilder.html" class="type-name-link" title="class in org.spdx.maven.utils">SpdxDocumentBuilder</a> - Class in <a href="org/spdx/maven/utils/package-summary.html">org.spdx.maven.utils</a></dt>
<dd>
<div class="block">Builds SPDX documents for a given set of source files.</div>
</dd>
<dt><a href="org/spdx/maven/utils/SpdxDocumentBuilder.html#%3Cinit%3E(java.io.File,java.net.URI,boolean,org.spdx.maven.OutputFormat)" class="member-name-link">SpdxDocumentBuilder(File, URI, boolean, OutputFormat)</a> - Constructor for class org.spdx.maven.utils.<a href="org/spdx/maven/utils/SpdxDocumentBuilder.html" title="class in org.spdx.maven.utils">SpdxDocumentBuilder</a></dt>
<dt><a href="org/spdx/maven/utils/SpdxDocumentBuilder.html#%3Cinit%3E(org.apache.maven.project.MavenProject,boolean,java.io.File,java.net.URI,boolean,org.spdx.maven.OutputFormat)" class="member-name-link">SpdxDocumentBuilder(MavenProject, boolean, File, URI, boolean, OutputFormat)</a> - Constructor for class org.spdx.maven.utils.<a href="org/spdx/maven/utils/SpdxDocumentBuilder.html" title="class in org.spdx.maven.utils">SpdxDocumentBuilder</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/spdx/maven/utils/SpdxExternalRefBuilder.html" class="type-name-link" title="class in org.spdx.maven.utils">SpdxExternalRefBuilder</a> - Class in <a href="org/spdx/maven/utils/package-summary.html">org.spdx.maven.utils</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/spdx/maven/utils/SpdxExternalRefBuilder.html#%3Cinit%3E()" class="member-name-link">SpdxExternalRefBuilder()</a> - Constructor for class org.spdx.maven.utils.<a href="org/spdx/maven/utils/SpdxExternalRefBuilder.html" title="class in org.spdx.maven.utils">SpdxExternalRefBuilder</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/spdx/maven/utils/SpdxFileCollector.html" class="type-name-link" title="class in org.spdx.maven.utils">SpdxFileCollector</a> - Class in <a href="org/spdx/maven/utils/package-summary.html">org.spdx.maven.utils</a></dt>
<dd>
Expand Down
2 changes: 1 addition & 1 deletion apidocs/member-search-index.js

Large diffs are not rendered by default.

4 changes: 3 additions & 1 deletion apidocs/org/spdx/maven/class-use/OutputFormat.html
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,9 @@ <h2>Uses of <a href="../OutputFormat.html" title="enum in org.spdx.maven">Output
<div class="table-header col-second">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../utils/SpdxDocumentBuilder.html#%3Cinit%3E(java.io.File,java.net.URI,boolean,org.spdx.maven.OutputFormat)" class="member-name-link">SpdxDocumentBuilder</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>&nbsp;spdxFile,
<div class="col-second even-row-color"><code><a href="../utils/SpdxDocumentBuilder.html#%3Cinit%3E(org.apache.maven.project.MavenProject,boolean,java.io.File,java.net.URI,boolean,org.spdx.maven.OutputFormat)" class="member-name-link">SpdxDocumentBuilder</a><wbr>(org.apache.maven.project.MavenProject&nbsp;project,
boolean&nbsp;generatePurls,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>&nbsp;spdxFile,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a>&nbsp;spdxDocumentNamespace,
boolean&nbsp;useStdLicenseSourceUrls,
<a href="../OutputFormat.html" title="enum in org.spdx.maven">OutputFormat</a>&nbsp;outputFormat)</code></div>
Expand Down
10 changes: 6 additions & 4 deletions apidocs/org/spdx/maven/utils/SpdxDependencyInformation.html
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,10 @@ <h2>Constructor Summary</h2>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.spdx.maven.utils.LicenseManager,org.spdx.library.model.SpdxDocument,boolean)" class="member-name-link">SpdxDependencyInformation</a><wbr>(<a href="LicenseManager.html" title="class in org.spdx.maven.utils">LicenseManager</a>&nbsp;licenseManager,
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.spdx.maven.utils.LicenseManager,org.spdx.library.model.SpdxDocument,boolean,boolean)" class="member-name-link">SpdxDependencyInformation</a><wbr>(<a href="LicenseManager.html" title="class in org.spdx.maven.utils">LicenseManager</a>&nbsp;licenseManager,
<a href="https://spdx.github.io/Spdx-Java-Library/org/spdx/library/model/SpdxDocument.html" title="class or interface in org.spdx.library.model" class="external-link">SpdxDocument</a>&nbsp;spdxDoc,
boolean&nbsp;createExternalRefs)</code></div>
boolean&nbsp;createExternalRefs,
boolean&nbsp;generatePurls)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
Expand Down Expand Up @@ -160,11 +161,12 @@ <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from cl
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(org.spdx.maven.utils.LicenseManager,org.spdx.library.model.SpdxDocument,boolean)">
<section class="detail" id="&lt;init&gt;(org.spdx.maven.utils.LicenseManager,org.spdx.library.model.SpdxDocument,boolean,boolean)">
<h3>SpdxDependencyInformation</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">SpdxDependencyInformation</span><wbr><span class="parameters">(<a href="LicenseManager.html" title="class in org.spdx.maven.utils">LicenseManager</a>&nbsp;licenseManager,
<a href="https://spdx.github.io/Spdx-Java-Library/org/spdx/library/model/SpdxDocument.html" title="class or interface in org.spdx.library.model" class="external-link">SpdxDocument</a>&nbsp;spdxDoc,
boolean&nbsp;createExternalRefs)</span></div>
boolean&nbsp;createExternalRefs,
boolean&nbsp;generatePurls)</span></div>
</section>
</li>
</ul>
Expand Down
10 changes: 7 additions & 3 deletions apidocs/org/spdx/maven/utils/SpdxDocumentBuilder.html
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,9 @@ <h2>Constructor Summary</h2>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.io.File,java.net.URI,boolean,org.spdx.maven.OutputFormat)" class="member-name-link">SpdxDocumentBuilder</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>&nbsp;spdxFile,
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.maven.project.MavenProject,boolean,java.io.File,java.net.URI,boolean,org.spdx.maven.OutputFormat)" class="member-name-link">SpdxDocumentBuilder</a><wbr>(org.apache.maven.project.MavenProject&nbsp;project,
boolean&nbsp;generatePurls,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>&nbsp;spdxFile,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a>&nbsp;spdxDocumentNamespace,
boolean&nbsp;useStdLicenseSourceUrls,
<a href="../OutputFormat.html" title="enum in org.spdx.maven">OutputFormat</a>&nbsp;outputFormat)</code></div>
Expand Down Expand Up @@ -202,9 +204,11 @@ <h3>NULL_SHA1</h3>
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(java.io.File,java.net.URI,boolean,org.spdx.maven.OutputFormat)">
<section class="detail" id="&lt;init&gt;(org.apache.maven.project.MavenProject,boolean,java.io.File,java.net.URI,boolean,org.spdx.maven.OutputFormat)">
<h3>SpdxDocumentBuilder</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">SpdxDocumentBuilder</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>&nbsp;spdxFile,
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">SpdxDocumentBuilder</span><wbr><span class="parameters">(org.apache.maven.project.MavenProject&nbsp;project,
boolean&nbsp;generatePurls,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>&nbsp;spdxFile,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a>&nbsp;spdxDocumentNamespace,
boolean&nbsp;useStdLicenseSourceUrls,
<a href="../OutputFormat.html" title="enum in org.spdx.maven">OutputFormat</a>&nbsp;outputFormat)</span>
Expand Down
Loading

0 comments on commit 3058d95

Please sign in to comment.