Skip to content

Commit 1fd956c

Browse files
cdimasciocdimascio
authoredSep 21, 2020
Javadoc (#7)
* generate javadoc * generated javadoc * update README * generated javadoc * update pom * update pom * update ci * disable doc move * relocate javadoc to docs
·
v3.2.0v2.1.0
1 parent e8832d8 commit 1fd956c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

68 files changed

+43534
-2
lines changed
 

‎docs/javadoc/allclasses-index.html

+164
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,164 @@
1+
<!DOCTYPE HTML>
2+
<!-- NewPage -->
3+
<html lang="en">
4+
<head>
5+
<!-- Generated by javadoc (14.0.1) on Sun Sep 20 11:03:40 EDT 2020 -->
6+
<title>All Classes (dotenv-java 1.1.0 API)</title>
7+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8+
<meta name="dc.created" content="2020-09-20">
9+
<meta name="description" content="class index">
10+
<meta name="generator" content="javadoc/AllClassesIndexWriter">
11+
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
12+
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.css" title="Style">
13+
<script type="text/javascript" src="script.js"></script>
14+
<script type="text/javascript" src="script-dir/jszip/dist/jszip.min.js"></script>
15+
<script type="text/javascript" src="script-dir/jszip-utils/dist/jszip-utils.min.js"></script>
16+
<!--[if IE]>
17+
<script type="text/javascript" src="script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script>
18+
<![endif]-->
19+
<script type="text/javascript" src="script-dir/jquery-3.4.1.js"></script>
20+
<script type="text/javascript" src="script-dir/jquery-ui.js"></script>
21+
</head>
22+
<body class="all-classes-index">
23+
<script type="text/javascript">var data = {"i0":2,"i1":1,"i2":2,"i3":2,"i4":4,"i5":8,"i6":2,"i7":2};
24+
var tabs = {65535:["t0","All Classes"],1:["t1","Interface Summary"],2:["t2","Class Summary"],4:["t3","Enum Summary"],8:["t4","Exception Summary"]};
25+
var altColor = "altColor";
26+
var rowColor = "rowColor";
27+
var tableTab = "tableTab";
28+
var activeTableTab = "activeTableTab";
29+
var pathtoroot = "./";
30+
loadScripts(document, 'script');</script>
31+
<noscript>
32+
<div>JavaScript is disabled on your browser.</div>
33+
</noscript>
34+
<div class="flexBox">
35+
<header role="banner" class="flexHeader">
36+
<nav role="navigation">
37+
<!-- ========= START OF TOP NAVBAR ======= -->
38+
<div class="topNav"><a id="navbar.top">
39+
<!-- -->
40+
</a>
41+
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
42+
<a id="navbar.top.firstrow">
43+
<!-- -->
44+
</a>
45+
<ul class="navList" title="Navigation">
46+
<li><a href="index.html">Overview</a></li>
47+
<li>Package</li>
48+
<li>Class</li>
49+
<li>Use</li>
50+
<li><a href="overview-tree.html">Tree</a></li>
51+
<li><a href="deprecated-list.html">Deprecated</a></li>
52+
<li><a href="index-all.html">Index</a></li>
53+
<li><a href="help-doc.html">Help</a></li>
54+
</ul>
55+
</div>
56+
<div class="subNav">
57+
<div class="navListSearch"><label for="search">SEARCH:</label>
58+
<input type="text" id="search" value="search" disabled="disabled">
59+
<input type="reset" id="reset" value="reset" disabled="disabled">
60+
</div>
61+
</div>
62+
<!-- ========= END OF TOP NAVBAR ========= -->
63+
<div class="skipNav"><a id="skip.navbar.top">
64+
<!-- -->
65+
</a></div>
66+
</nav>
67+
</header>
68+
<div class="flexContent">
69+
<main role="main">
70+
<div class="header">
71+
<h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
72+
</div>
73+
<div class="allClassesContainer">
74+
<div class="typeSummary">
75+
<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>
76+
<div id="typeSummary_tabpanel" role="tabpanel">
77+
<table aria-labelledby="t0">
78+
<thead>
79+
<tr>
80+
<th class="colFirst" scope="col">Class</th>
81+
<th class="colLast" scope="col">Description</th>
82+
</tr>
83+
</thead>
84+
<tbody>
85+
<tr class="altColor" id="i0">
86+
<td class="colFirst"><a href="io/github/cdimascio/dotenv/internal/ClasspathHelper.html" title="class in io.github.cdimascio.dotenv.internal">ClasspathHelper</a></td>
87+
<th class="colLast" scope="row">&nbsp;</th>
88+
</tr>
89+
<tr class="rowColor" id="i1">
90+
<td class="colFirst"><a href="io/github/cdimascio/dotenv/Dotenv.html" title="interface in io.github.cdimascio.dotenv">Dotenv</a></td>
91+
<th class="colLast" scope="row">
92+
<div class="block">Creates and configures a new dotenv instance</div>
93+
</th>
94+
</tr>
95+
<tr class="altColor" id="i2">
96+
<td class="colFirst"><a href="io/github/cdimascio/dotenv/DotenvBuilder.html" title="class in io.github.cdimascio.dotenv">DotenvBuilder</a></td>
97+
<th class="colLast" scope="row">
98+
<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>
99+
</th>
100+
</tr>
101+
<tr class="rowColor" id="i3">
102+
<td class="colFirst"><a href="io/github/cdimascio/dotenv/DotenvEntry.html" title="class in io.github.cdimascio.dotenv">DotenvEntry</a></td>
103+
<th class="colLast" scope="row">
104+
<div class="block">A key value pair representing an environment variable and its value</div>
105+
</th>
106+
</tr>
107+
<tr class="altColor" id="i4">
108+
<td class="colFirst"><a href="io/github/cdimascio/dotenv/DotenvEntry.Filter.html" title="enum in io.github.cdimascio.dotenv">DotenvEntry.Filter</a></td>
109+
<th class="colLast" scope="row">
110+
<div class="block">A dotenv entry filter</div>
111+
</th>
112+
</tr>
113+
<tr class="rowColor" id="i5">
114+
<td class="colFirst"><a href="io/github/cdimascio/dotenv/DotenvException.html" title="class in io.github.cdimascio.dotenv">DotenvException</a></td>
115+
<th class="colLast" scope="row">
116+
<div class="block">Signals that dotenv exception of some sort has occurred.</div>
117+
</th>
118+
</tr>
119+
<tr class="altColor" id="i6">
120+
<td class="colFirst"><a href="io/github/cdimascio/dotenv/internal/DotenvParser.html" title="class in io.github.cdimascio.dotenv.internal">DotenvParser</a></td>
121+
<th class="colLast" scope="row">&nbsp;</th>
122+
</tr>
123+
<tr class="rowColor" id="i7">
124+
<td class="colFirst"><a href="io/github/cdimascio/dotenv/internal/DotenvReader.html" title="class in io.github.cdimascio.dotenv.internal">DotenvReader</a></td>
125+
<th class="colLast" scope="row">&nbsp;</th>
126+
</tr>
127+
</tbody>
128+
</table>
129+
</div>
130+
</div>
131+
</div>
132+
</main>
133+
<footer role="contentinfo">
134+
<nav role="navigation">
135+
<!-- ======= START OF BOTTOM NAVBAR ====== -->
136+
<div class="bottomNav"><a id="navbar.bottom">
137+
<!-- -->
138+
</a>
139+
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
140+
<a id="navbar.bottom.firstrow">
141+
<!-- -->
142+
</a>
143+
<ul class="navList" title="Navigation">
144+
<li><a href="index.html">Overview</a></li>
145+
<li>Package</li>
146+
<li>Class</li>
147+
<li>Use</li>
148+
<li><a href="overview-tree.html">Tree</a></li>
149+
<li><a href="deprecated-list.html">Deprecated</a></li>
150+
<li><a href="index-all.html">Index</a></li>
151+
<li><a href="help-doc.html">Help</a></li>
152+
</ul>
153+
</div>
154+
<a id="skip.navbar.bottom">
155+
<!-- -->
156+
</a>
157+
<!-- ======== END OF BOTTOM NAVBAR ======= -->
158+
</nav>
159+
<p class="legalCopy"><small>Copyright &#169; 2020 <a href="https://github.com/cdimascio">Carmine DiMascio OSS</a>. All rights reserved.</small></p>
160+
</footer>
161+
</div>
162+
</div>
163+
</body>
164+
</html>

‎docs/javadoc/allpackages-index.html

+126
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
<!DOCTYPE HTML>
2+
<!-- NewPage -->
3+
<html lang="en">
4+
<head>
5+
<!-- Generated by javadoc (14.0.1) on Sun Sep 20 11:03:40 EDT 2020 -->
6+
<title>All Packages (dotenv-java 1.1.0 API)</title>
7+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8+
<meta name="dc.created" content="2020-09-20">
9+
<meta name="description" content="package index">
10+
<meta name="generator" content="javadoc/AllPackagesIndexWriter">
11+
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
12+
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.css" title="Style">
13+
<script type="text/javascript" src="script.js"></script>
14+
<script type="text/javascript" src="script-dir/jszip/dist/jszip.min.js"></script>
15+
<script type="text/javascript" src="script-dir/jszip-utils/dist/jszip-utils.min.js"></script>
16+
<!--[if IE]>
17+
<script type="text/javascript" src="script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script>
18+
<![endif]-->
19+
<script type="text/javascript" src="script-dir/jquery-3.4.1.js"></script>
20+
<script type="text/javascript" src="script-dir/jquery-ui.js"></script>
21+
</head>
22+
<body class="all-packages-index">
23+
<script type="text/javascript">var pathtoroot = "./";
24+
loadScripts(document, 'script');</script>
25+
<noscript>
26+
<div>JavaScript is disabled on your browser.</div>
27+
</noscript>
28+
<div class="flexBox">
29+
<header role="banner" class="flexHeader">
30+
<nav role="navigation">
31+
<!-- ========= START OF TOP NAVBAR ======= -->
32+
<div class="topNav"><a id="navbar.top">
33+
<!-- -->
34+
</a>
35+
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
36+
<a id="navbar.top.firstrow">
37+
<!-- -->
38+
</a>
39+
<ul class="navList" title="Navigation">
40+
<li><a href="index.html">Overview</a></li>
41+
<li>Package</li>
42+
<li>Class</li>
43+
<li>Use</li>
44+
<li><a href="overview-tree.html">Tree</a></li>
45+
<li><a href="deprecated-list.html">Deprecated</a></li>
46+
<li><a href="index-all.html">Index</a></li>
47+
<li><a href="help-doc.html">Help</a></li>
48+
</ul>
49+
</div>
50+
<div class="subNav">
51+
<div class="navListSearch"><label for="search">SEARCH:</label>
52+
<input type="text" id="search" value="search" disabled="disabled">
53+
<input type="reset" id="reset" value="reset" disabled="disabled">
54+
</div>
55+
</div>
56+
<!-- ========= END OF TOP NAVBAR ========= -->
57+
<div class="skipNav"><a id="skip.navbar.top">
58+
<!-- -->
59+
</a></div>
60+
</nav>
61+
</header>
62+
<div class="flexContent">
63+
<main role="main">
64+
<div class="header">
65+
<h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
66+
</div>
67+
<div class="allPackagesContainer">
68+
<div class="packagesSummary">
69+
<table>
70+
<caption><span>Package Summary</span><span class="tabEnd">&nbsp;</span></caption>
71+
<thead>
72+
<tr>
73+
<th class="colFirst" scope="col">Package</th>
74+
<th class="colLast" scope="col">Description</th>
75+
</tr>
76+
</thead>
77+
<tbody>
78+
<tr class="altColor">
79+
<th class="colFirst" scope="row"><a href="io/github/cdimascio/dotenv/package-summary.html">io.github.cdimascio.dotenv</a></th>
80+
<td class="colLast">
81+
<div class="block">Provides a system to manage environment variables using a .env file.</div>
82+
</td>
83+
</tr>
84+
<tr class="rowColor">
85+
<th class="colFirst" scope="row"><a href="io/github/cdimascio/dotenv/internal/package-summary.html">io.github.cdimascio.dotenv.internal</a></th>
86+
<td class="colLast">
87+
<div class="block">Provides a set of internal helpers for dotenv (not for external use).</div>
88+
</td>
89+
</tr>
90+
</tbody>
91+
</table>
92+
</div>
93+
</div>
94+
</main>
95+
<footer role="contentinfo">
96+
<nav role="navigation">
97+
<!-- ======= START OF BOTTOM NAVBAR ====== -->
98+
<div class="bottomNav"><a id="navbar.bottom">
99+
<!-- -->
100+
</a>
101+
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
102+
<a id="navbar.bottom.firstrow">
103+
<!-- -->
104+
</a>
105+
<ul class="navList" title="Navigation">
106+
<li><a href="index.html">Overview</a></li>
107+
<li>Package</li>
108+
<li>Class</li>
109+
<li>Use</li>
110+
<li><a href="overview-tree.html">Tree</a></li>
111+
<li><a href="deprecated-list.html">Deprecated</a></li>
112+
<li><a href="index-all.html">Index</a></li>
113+
<li><a href="help-doc.html">Help</a></li>
114+
</ul>
115+
</div>
116+
<a id="skip.navbar.bottom">
117+
<!-- -->
118+
</a>
119+
<!-- ======== END OF BOTTOM NAVBAR ======= -->
120+
</nav>
121+
<p class="legalCopy"><small>Copyright &#169; 2020 <a href="https://github.com/cdimascio">Carmine DiMascio OSS</a>. All rights reserved.</small></p>
122+
</footer>
123+
</div>
124+
</div>
125+
</body>
126+
</html>

0 commit comments

Comments
 (0)
Please sign in to comment.