Javadoc (#7)

* generate javadoc * generated javadoc * update README * generated javadoc * update pom * update pom * update ci * disable doc move * relocate javadoc to docs
cdimascio · Sep 21, 2020 · 1fd956c · 1fd956c
1 parent e8832d8
commit 1fd956c
Show file tree

Hide file tree

Showing 68 changed files with 43,534 additions and 2 deletions.
diff --git a/docs/javadoc/allclasses-index.html b/docs/javadoc/allclasses-index.html
@@ -0,0 +1,164 @@
+<!DOCTYPE HTML>
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (14.0.1) on Sun Sep 20 11:03:40 EDT 2020 -->
+<title>All Classes (dotenv-java 1.1.0 API)</title>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<meta name="dc.created" content="2020-09-20">
+<meta name="description" content="class index">
+<meta name="generator" content="javadoc/AllClassesIndexWriter">
+<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
+<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.css" title="Style">
+<script type="text/javascript" src="script.js"></script>
+<script type="text/javascript" src="script-dir/jszip/dist/jszip.min.js"></script>
+<script type="text/javascript" src="script-dir/jszip-utils/dist/jszip-utils.min.js"></script>
+<!--[if IE]>
+<script type="text/javascript" src="script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script>
+<![endif]-->
+<script type="text/javascript" src="script-dir/jquery-3.4.1.js"></script>
+<script type="text/javascript" src="script-dir/jquery-ui.js"></script>
+</head>
+<body class="all-classes-index">
+<script type="text/javascript">var data = {"i0":2,"i1":1,"i2":2,"i3":2,"i4":4,"i5":8,"i6":2,"i7":2};
+var tabs = {65535:["t0","All Classes"],1:["t1","Interface Summary"],2:["t2","Class Summary"],4:["t3","Enum Summary"],8:["t4","Exception Summary"]};
+var altColor = "altColor";
+var rowColor = "rowColor";
+var tableTab = "tableTab";
+var activeTableTab = "activeTableTab";
+var pathtoroot = "./";
+loadScripts(document, 'script');</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<div class="flexBox">
+<header role="banner" class="flexHeader">
+<nav role="navigation">
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a id="navbar.top">
+<!--   -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<a id="navbar.top.firstrow">
+<!--   -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="index.html">Overview</a></li>
+<li>Package</li>
+<li>Class</li>
+<li>Use</li>
+<li><a href="overview-tree.html">Tree</a></li>
+<li><a href="deprecated-list.html">Deprecated</a></li>
+<li><a href="index-all.html">Index</a></li>
+<li><a href="help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<div class="navListSearch"><label for="search">SEARCH:</label>
+<input type="text" id="search" value="search" disabled="disabled">
+<input type="reset" id="reset" value="reset" disabled="disabled">
+</div>
+</div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<div class="skipNav"><a id="skip.navbar.top">
+<!--   -->
+</a></div>
+</nav>
+</header>
+<div class="flexContent">
+<main role="main">
+<div class="header">
+<h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
+</div>
+<div class="allClassesContainer">
+<div class="typeSummary">
+<div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="typeSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Classes</button><button role="tab" aria-selected="false" aria-controls="typeSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t1" class="tableTab" onclick="show(1);">Interface Summary</button><button role="tab" aria-selected="false" aria-controls="typeSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Class Summary</button><button role="tab" aria-selected="false" aria-controls="typeSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="tableTab" onclick="show(4);">Enum Summary</button><button role="tab" aria-selected="false" aria-controls="typeSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Exception Summary</button></div>
+<div id="typeSummary_tabpanel" role="tabpanel">
+<table aria-labelledby="t0">
+<thead>
+<tr>
+<th class="colFirst" scope="col">Class</th>
+<th class="colLast" scope="col">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr class="altColor" id="i0">
+<td class="colFirst"><a href="io/github/cdimascio/dotenv/internal/ClasspathHelper.html" title="class in io.github.cdimascio.dotenv.internal">ClasspathHelper</a></td>
+<th class="colLast" scope="row">&nbsp;</th>
+</tr>
+<tr class="rowColor" id="i1">
+<td class="colFirst"><a href="io/github/cdimascio/dotenv/Dotenv.html" title="interface in io.github.cdimascio.dotenv">Dotenv</a></td>
+<th class="colLast" scope="row">
+<div class="block">Creates and configures a new dotenv instance</div>
+</th>
+</tr>
+<tr class="altColor" id="i2">
+<td class="colFirst"><a href="io/github/cdimascio/dotenv/DotenvBuilder.html" title="class in io.github.cdimascio.dotenv">DotenvBuilder</a></td>
+<th class="colLast" scope="row">
+<div class="block">Builds and loads and <a href="io/github/cdimascio/dotenv/Dotenv.html" title="interface in io.github.cdimascio.dotenv"><code>Dotenv</code></a> instance</div>
+</th>
+</tr>
+<tr class="rowColor" id="i3">
+<td class="colFirst"><a href="io/github/cdimascio/dotenv/DotenvEntry.html" title="class in io.github.cdimascio.dotenv">DotenvEntry</a></td>
+<th class="colLast" scope="row">
+<div class="block">A key value pair representing an environment variable and its value</div>
+</th>
+</tr>
+<tr class="altColor" id="i4">
+<td class="colFirst"><a href="io/github/cdimascio/dotenv/DotenvEntry.Filter.html" title="enum in io.github.cdimascio.dotenv">DotenvEntry.Filter</a></td>
+<th class="colLast" scope="row">
+<div class="block">A dotenv entry filter</div>
+</th>
+</tr>
+<tr class="rowColor" id="i5">
+<td class="colFirst"><a href="io/github/cdimascio/dotenv/DotenvException.html" title="class in io.github.cdimascio.dotenv">DotenvException</a></td>
+<th class="colLast" scope="row">
+<div class="block">Signals that dotenv exception of some sort has occurred.</div>
+</th>
+</tr>
+<tr class="altColor" id="i6">
+<td class="colFirst"><a href="io/github/cdimascio/dotenv/internal/DotenvParser.html" title="class in io.github.cdimascio.dotenv.internal">DotenvParser</a></td>
+<th class="colLast" scope="row">&nbsp;</th>
+</tr>
+<tr class="rowColor" id="i7">
+<td class="colFirst"><a href="io/github/cdimascio/dotenv/internal/DotenvReader.html" title="class in io.github.cdimascio.dotenv.internal">DotenvReader</a></td>
+<th class="colLast" scope="row">&nbsp;</th>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+</div>
+</main>
+<footer role="contentinfo">
+<nav role="navigation">
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottomNav"><a id="navbar.bottom">
+<!--   -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<a id="navbar.bottom.firstrow">
+<!--   -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="index.html">Overview</a></li>
+<li>Package</li>
+<li>Class</li>
+<li>Use</li>
+<li><a href="overview-tree.html">Tree</a></li>
+<li><a href="deprecated-list.html">Deprecated</a></li>
+<li><a href="index-all.html">Index</a></li>
+<li><a href="help-doc.html">Help</a></li>
+</ul>
+</div>
+<a id="skip.navbar.bottom">
+<!--   -->
+</a>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</nav>
+<p class="legalCopy"><small>Copyright &#169; 2020 <a href="https://github.com/cdimascio">Carmine DiMascio OSS</a>. All rights reserved.</small></p>
+</footer>
+</div>
+</div>
+</body>
+</html>
diff --git a/docs/javadoc/allpackages-index.html b/docs/javadoc/allpackages-index.html
@@ -0,0 +1,126 @@
+<!DOCTYPE HTML>
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (14.0.1) on Sun Sep 20 11:03:40 EDT 2020 -->
+<title>All Packages (dotenv-java 1.1.0 API)</title>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<meta name="dc.created" content="2020-09-20">
+<meta name="description" content="package index">
+<meta name="generator" content="javadoc/AllPackagesIndexWriter">
+<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
+<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.css" title="Style">
+<script type="text/javascript" src="script.js"></script>
+<script type="text/javascript" src="script-dir/jszip/dist/jszip.min.js"></script>
+<script type="text/javascript" src="script-dir/jszip-utils/dist/jszip-utils.min.js"></script>
+<!--[if IE]>
+<script type="text/javascript" src="script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script>
+<![endif]-->
+<script type="text/javascript" src="script-dir/jquery-3.4.1.js"></script>
+<script type="text/javascript" src="script-dir/jquery-ui.js"></script>
+</head>
+<body class="all-packages-index">
+<script type="text/javascript">var pathtoroot = "./";
+loadScripts(document, 'script');</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<div class="flexBox">
+<header role="banner" class="flexHeader">
+<nav role="navigation">
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a id="navbar.top">
+<!--   -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<a id="navbar.top.firstrow">
+<!--   -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="index.html">Overview</a></li>
+<li>Package</li>
+<li>Class</li>
+<li>Use</li>
+<li><a href="overview-tree.html">Tree</a></li>
+<li><a href="deprecated-list.html">Deprecated</a></li>
+<li><a href="index-all.html">Index</a></li>
+<li><a href="help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<div class="navListSearch"><label for="search">SEARCH:</label>
+<input type="text" id="search" value="search" disabled="disabled">
+<input type="reset" id="reset" value="reset" disabled="disabled">
+</div>
+</div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<div class="skipNav"><a id="skip.navbar.top">
+<!--   -->
+</a></div>
+</nav>
+</header>
+<div class="flexContent">
+<main role="main">
+<div class="header">
+<h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
+</div>
+<div class="allPackagesContainer">
+<div class="packagesSummary">
+<table>
+<caption><span>Package Summary</span><span class="tabEnd">&nbsp;</span></caption>
+<thead>
+<tr>
+<th class="colFirst" scope="col">Package</th>
+<th class="colLast" scope="col">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr class="altColor">
+<th class="colFirst" scope="row"><a href="io/github/cdimascio/dotenv/package-summary.html">io.github.cdimascio.dotenv</a></th>
+<td class="colLast">
+<div class="block">Provides a system to manage environment variables using a .env file.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<th class="colFirst" scope="row"><a href="io/github/cdimascio/dotenv/internal/package-summary.html">io.github.cdimascio.dotenv.internal</a></th>
+<td class="colLast">
+<div class="block">Provides a set of internal helpers for dotenv (not for external use).</div>
+</td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+</main>
+<footer role="contentinfo">
+<nav role="navigation">
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottomNav"><a id="navbar.bottom">
+<!--   -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<a id="navbar.bottom.firstrow">
+<!--   -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="index.html">Overview</a></li>
+<li>Package</li>
+<li>Class</li>
+<li>Use</li>
+<li><a href="overview-tree.html">Tree</a></li>
+<li><a href="deprecated-list.html">Deprecated</a></li>
+<li><a href="index-all.html">Index</a></li>
+<li><a href="help-doc.html">Help</a></li>
+</ul>
+</div>
+<a id="skip.navbar.bottom">
+<!--   -->
+</a>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</nav>
+<p class="legalCopy"><small>Copyright &#169; 2020 <a href="https://github.com/cdimascio">Carmine DiMascio OSS</a>. All rights reserved.</small></p>
+</footer>
+</div>
+</div>
+</body>
+</html>
diff --git a/docs/javadoc/constant-values.html b/docs/javadoc/constant-values.html
@@ -0,0 +1,102 @@
+<!DOCTYPE HTML>
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (14.0.1) on Sun Sep 20 11:03:40 EDT 2020 -->
+<title>Constant Field Values (dotenv-java 1.1.0 API)</title>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<meta name="dc.created" content="2020-09-20">
+<meta name="description" content="summary of constants">
+<meta name="generator" content="javadoc/ConstantsSummaryWriterImpl">
+<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
+<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.css" title="Style">
+<script type="text/javascript" src="script.js"></script>
+<script type="text/javascript" src="script-dir/jszip/dist/jszip.min.js"></script>
+<script type="text/javascript" src="script-dir/jszip-utils/dist/jszip-utils.min.js"></script>
+<!--[if IE]>
+<script type="text/javascript" src="script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script>
+<![endif]-->
+<script type="text/javascript" src="script-dir/jquery-3.4.1.js"></script>
+<script type="text/javascript" src="script-dir/jquery-ui.js"></script>
+</head>
+<body class="constants-summary">
+<script type="text/javascript">var pathtoroot = "./";
+loadScripts(document, 'script');</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<div class="flexBox">
+<header role="banner" class="flexHeader">
+<nav role="navigation">
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a id="navbar.top">
+<!--   -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<a id="navbar.top.firstrow">
+<!--   -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="index.html">Overview</a></li>
+<li>Package</li>
+<li>Class</li>
+<li>Use</li>
+<li><a href="overview-tree.html">Tree</a></li>
+<li><a href="deprecated-list.html">Deprecated</a></li>
+<li><a href="index-all.html">Index</a></li>
+<li><a href="help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<div class="navListSearch"><label for="search">SEARCH:</label>
+<input type="text" id="search" value="search" disabled="disabled">
+<input type="reset" id="reset" value="reset" disabled="disabled">
+</div>
+</div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<div class="skipNav"><a id="skip.navbar.top">
+<!--   -->
+</a></div>
+</nav>
+</header>
+<div class="flexContent">
+<main role="main">
+<div class="header">
+<h1 title="Constant Field Values" class="title">Constant Field Values</h1>
+<section class="packages">
+<h2 title="Contents">Contents</h2>
+</section>
+</div>
+</main>
+<footer role="contentinfo">
+<nav role="navigation">
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottomNav"><a id="navbar.bottom">
+<!--   -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<a id="navbar.bottom.firstrow">
+<!--   -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="index.html">Overview</a></li>
+<li>Package</li>
+<li>Class</li>
+<li>Use</li>
+<li><a href="overview-tree.html">Tree</a></li>
+<li><a href="deprecated-list.html">Deprecated</a></li>
+<li><a href="index-all.html">Index</a></li>
+<li><a href="help-doc.html">Help</a></li>
+</ul>
+</div>
+<a id="skip.navbar.bottom">
+<!--   -->
+</a>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</nav>
+<p class="legalCopy"><small>Copyright &#169; 2020 <a href="https://github.com/cdimascio">Carmine DiMascio OSS</a>. All rights reserved.</small></p>
+</footer>
+</div>
+</div>
+</body>
+</html>