Skip to content

Commit c033f79

Browse files
author
mrhunsaker
committed
javadoc updates
1 parent 7a80eef commit c033f79

File tree

379 files changed

+35720
-288
lines changed

Some content is hidden

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

379 files changed

+35720
-288
lines changed

‎dependency-reduced-pom.xml‎

Lines changed: 52 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
<url>https://github.com/mrhunsaker/</url>
2727
</organization>
2828
<build>
29-
<finalName>vision-skills-progression-tracker-${project.version}</finalName>
29+
<finalName>StudentDataGUI-${project.version}</finalName>
3030
<plugins>
3131
<plugin>
3232
<artifactId>maven-javadoc-plugin</artifactId>
@@ -40,6 +40,16 @@
4040
</execution>
4141
</executions>
4242
<inherited>true</inherited>
43+
<configuration>
44+
<encoding>${project.build.sourceEncoding}</encoding>
45+
<show>protected</show>
46+
<failOnError>false</failOnError>
47+
<doclint>none</doclint>
48+
<additionalparam>-Xdoclint:none</additionalparam>
49+
<source>${maven.compiler.release}</source>
50+
<linksource>true</linksource>
51+
<quiet>true</quiet>
52+
</configuration>
4353
</plugin>
4454
<plugin>
4555
<artifactId>maven-resources-plugin</artifactId>
@@ -178,6 +188,47 @@
178188
</dependencies>
179189
<reporting>
180190
<plugins>
191+
<plugin>
192+
<artifactId>maven-project-info-reports-plugin</artifactId>
193+
<version>3.4.5</version>
194+
<reportSets>
195+
<reportSet>
196+
<reports>
197+
<report>index</report>
198+
<report>summary</report>
199+
<report>licenses</report>
200+
<report>scm</report>
201+
<report>dependencies</report>
202+
<report>dependency-info</report>
203+
<report>dependency-management</report>
204+
<report>modules</report>
205+
<report>plugins</report>
206+
</reports>
207+
</reportSet>
208+
</reportSets>
209+
</plugin>
210+
<plugin>
211+
<artifactId>maven-javadoc-plugin</artifactId>
212+
<version>3.8.0</version>
213+
<configuration>
214+
<encoding>${project.build.sourceEncoding}</encoding>
215+
<doclint>none</doclint>
216+
<failOnError>false</failOnError>
217+
<linksource>true</linksource>
218+
<quiet>true</quiet>
219+
</configuration>
220+
</plugin>
221+
<plugin>
222+
<artifactId>maven-surefire-report-plugin</artifactId>
223+
<version>3.5.0</version>
224+
<reportSets>
225+
<reportSet>
226+
<reports>
227+
<report>report</report>
228+
</reports>
229+
</reportSet>
230+
</reportSets>
231+
</plugin>
181232
<plugin>
182233
<artifactId>maven-checkstyle-plugin</artifactId>
183234
<version>3.4.0</version>

‎target/apidocs/VersionUtil.html‎

Lines changed: 166 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
1+
<!DOCTYPE HTML>
2+
<html lang>
3+
<head>
4+
<!-- Generated by javadoc (21) on Wed Dec 17 13:15:13 MST 2025 -->
5+
<title>VersionUtil (Vision Skills Progression Tracker 1.0.0-beta API)</title>
6+
<meta name="viewport" content="width=device-width, initial-scale=1">
7+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8+
<meta name="dc.created" content="2025-12-17">
9+
<meta name="description" content="declaration: class: VersionUtil">
10+
<meta name="generator" content="javadoc/ClassWriterImpl">
11+
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
12+
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
13+
<script type="text/javascript" src="script.js"></script>
14+
<script type="text/javascript" src="script-dir/jquery-3.7.1.min.js"></script>
15+
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
16+
</head>
17+
<body class="class-declaration-page">
18+
<script type="text/javascript">var pathtoroot = "./";
19+
loadScripts(document, 'script');</script>
20+
<noscript>
21+
<div>JavaScript is disabled on your browser.</div>
22+
</noscript>
23+
<div class="flex-box">
24+
<header role="banner" class="flex-header">
25+
<nav role="navigation">
26+
<!-- ========= START OF TOP NAVBAR ======= -->
27+
<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
28+
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
29+
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
30+
<li><a href="index.html">Overview</a></li>
31+
<li><a href="package-summary.html">Package</a></li>
32+
<li class="nav-bar-cell1-rev">Class</li>
33+
<li><a href="class-use/VersionUtil.html">Use</a></li>
34+
<li><a href="package-tree.html">Tree</a></li>
35+
<li><a href="deprecated-list.html">Deprecated</a></li>
36+
<li><a href="index-all.html">Index</a></li>
37+
<li><a href="help-doc.html#class">Help</a></li>
38+
</ul>
39+
<ul class="sub-nav-list-small">
40+
<li>
41+
<p>Summary:</p>
42+
<ul>
43+
<li>Nested</li>
44+
<li>Field</li>
45+
<li>Constr</li>
46+
<li><a href="#method-summary">Method</a></li>
47+
</ul>
48+
</li>
49+
<li>
50+
<p>Detail:</p>
51+
<ul>
52+
<li>Field</li>
53+
<li>Constr</li>
54+
<li><a href="#method-detail">Method</a></li>
55+
</ul>
56+
</li>
57+
</ul>
58+
</div>
59+
<div class="sub-nav">
60+
<div id="navbar-sub-list">
61+
<ul class="sub-nav-list">
62+
<li>Summary:&nbsp;</li>
63+
<li>Nested&nbsp;|&nbsp;</li>
64+
<li>Field&nbsp;|&nbsp;</li>
65+
<li>Constr&nbsp;|&nbsp;</li>
66+
<li><a href="#method-summary">Method</a></li>
67+
</ul>
68+
<ul class="sub-nav-list">
69+
<li>Detail:&nbsp;</li>
70+
<li>Field&nbsp;|&nbsp;</li>
71+
<li>Constr&nbsp;|&nbsp;</li>
72+
<li><a href="#method-detail">Method</a></li>
73+
</ul>
74+
</div>
75+
<div class="nav-list-search"><a href="search.html">SEARCH</a>
76+
<input type="text" id="search-input" disabled placeholder="Search">
77+
<input type="reset" id="reset-button" disabled value="reset">
78+
</div>
79+
</div>
80+
<!-- ========= END OF TOP NAVBAR ========= -->
81+
<span class="skip-nav" id="skip-navbar-top"></span></nav>
82+
</header>
83+
<div class="flex-content">
84+
<main role="main">
85+
<!-- ======== START OF CLASS DATA ======== -->
86+
<div class="header">
87+
<h1 title="Class VersionUtil" class="title">Class VersionUtil</h1>
88+
</div>
89+
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
90+
<div class="inheritance">VersionUtil</div>
91+
</div>
92+
<section class="class-description" id="class-description">
93+
<hr>
94+
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name"><a href="src-html/VersionUtil.html#line-15">VersionUtil</a></span>
95+
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
96+
<div class="block">Utility to surface project version information.
97+
98+
Reads the <code>/version.properties</code> file from the classpath and exposes
99+
the <a href="#getVersion()"><code>getVersion()</code></a> helper. If the file cannot be read, returns
100+
<code>"unknown"</code>.</div>
101+
</section>
102+
<section class="summary">
103+
<ul class="summary-list">
104+
<!-- ========== METHOD SUMMARY =========== -->
105+
<li>
106+
<section class="method-summary" id="method-summary">
107+
<h2>Method Summary</h2>
108+
<div id="method-summary-table">
109+
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
110+
<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0">
111+
<div class="summary-table three-column-summary">
112+
<div class="table-header col-first">Modifier and Type</div>
113+
<div class="table-header col-second">Method</div>
114+
<div class="table-header col-last">Description</div>
115+
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
116+
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getVersion()" class="member-name-link">getVersion</a>()</code></div>
117+
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
118+
<div class="block">Returns the version of the application.</div>
119+
</div>
120+
</div>
121+
</div>
122+
</div>
123+
<div class="inherited-list">
124+
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
125+
<code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
126+
</section>
127+
</li>
128+
</ul>
129+
</section>
130+
<section class="details">
131+
<ul class="details-list">
132+
<!-- ============ METHOD DETAIL ========== -->
133+
<li>
134+
<section class="method-details" id="method-detail">
135+
<h2>Method Details</h2>
136+
<ul class="member-list">
137+
<li>
138+
<section class="detail" id="getVersion()">
139+
<h3>getVersion</h3>
140+
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name"><a href="src-html/VersionUtil.html#line-59">getVersion</a></span>()</div>
141+
<div class="block">Returns the version of the application.
142+
<p>
143+
This method provides access to the version information that was loaded from the properties file.
144+
If the properties file could not be found or an error occurred, it returns "unknown".
145+
</p></div>
146+
<dl class="notes">
147+
<dt>Returns:</dt>
148+
<dd>The version of the application.</dd>
149+
</dl>
150+
</section>
151+
</li>
152+
</ul>
153+
</section>
154+
</li>
155+
</ul>
156+
</section>
157+
<!-- ========= END OF CLASS DATA ========= -->
158+
</main>
159+
<footer role="contentinfo">
160+
<hr>
161+
<p class="legal-copy"><small>Copyright &#169; 2025 <a href="https://github.com/mrhunsaker/">Michael Ryan Hunsaker, M.Ed., Ph.D.</a>. All rights reserved.</small></p>
162+
</footer>
163+
</div>
164+
</div>
165+
</body>
166+
</html>

0 commit comments

Comments
 (0)