-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Fixed javadoc errors * removed javadoc from .gitignore
- Loading branch information
Showing
63 changed files
with
11,062 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,7 +5,6 @@ bin/ | |
| build/ | ||
| target/ | ||
| out/ | ||
| src/docs/javadoc | ||
| .micronaut/ | ||
| .idea | ||
| *.iml | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
151 changes: 151 additions & 0 deletions
151
pi4micronaut-utils/src/docs/javadoc/allclasses-index.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,151 @@ | ||
| <!DOCTYPE HTML> | ||
| <html lang="en"> | ||
| <head> | ||
| <!-- Generated by javadoc (21) --> | ||
| <title>All Classes and Interfaces (pi4micronaut-utils v1.0 API)</title> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1"> | ||
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> | ||
| <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.min.css" title="Style"> | ||
| <script type="text/javascript" src="script.js"></script> | ||
| <script type="text/javascript" src="script-dir/jquery-3.6.1.min.js"></script> | ||
| <script type="text/javascript" src="script-dir/jquery-ui.min.js"></script> | ||
| </head> | ||
| <body class="all-classes-index-page"> | ||
| <script type="text/javascript">var pathtoroot = "./"; | ||
| loadScripts(document, 'script');</script> | ||
| <noscript> | ||
| <div>JavaScript is disabled on your browser.</div> | ||
| </noscript> | ||
| <div class="flex-box"> | ||
| <header role="banner" class="flex-header"> | ||
| <nav role="navigation"> | ||
| <!-- ========= START OF TOP NAVBAR ======= --> | ||
| <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"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button> | ||
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> | ||
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> | ||
| <li><a href="index.html">Overview</a></li> | ||
| <li>Package</li> | ||
| <li>Class</li> | ||
| <li><a href="overview-tree.html">Tree</a></li> | ||
| <li><a href="index-all.html">Index</a></li> | ||
| <li><a href="help-doc.html#all-classes">Help</a></li> | ||
| </ul> | ||
| </div> | ||
| <div class="sub-nav"> | ||
| <div id="navbar-sub-list"></div> | ||
| <div class="nav-list-search"><a href="search.html">SEARCH</a> | ||
| <input type="text" id="search-input" disabled placeholder="Search"> | ||
| <input type="reset" id="reset-button" disabled value="reset"> | ||
| </div> | ||
| </div> | ||
| <!-- ========= END OF TOP NAVBAR ========= --> | ||
| <span class="skip-nav" id="skip-navbar-top"></span></nav> | ||
| </header> | ||
| <div class="flex-content"> | ||
| <main role="main"> | ||
| <div class="header"> | ||
| <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces</h1> | ||
| </div> | ||
| <div id="all-classes-table"> | ||
| <div class="caption"><span>Classes</span></div> | ||
| <div class="summary-table two-column-summary"> | ||
| <div class="table-header col-first">Class</div> | ||
| <div class="table-header col-last">Description</div> | ||
| <div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/opensourcewithslu/outputdevices/ActiveBuzzerHelper.html" title="class in com.opensourcewithslu.outputdevices">ActiveBuzzerHelper</a></div> | ||
| <div class="col-last even-row-color all-classes-table all-classes-table-tab2"> | ||
| <div class="block">The ActiveBuzzerHelper class contains methods that pertain to the control of the active buzzer.</div> | ||
| </div> | ||
| <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/opensourcewithslu/Application.html" title="class in com.opensourcewithslu">Application</a></div> | ||
| <div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> | ||
| <div class="block">Runs the Micronaut framework in the Pi4Micronaut framework.</div> | ||
| </div> | ||
| <div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/opensourcewithslu/utilities/DigitalInputConfiguration.html" title="class in com.opensourcewithslu.utilities">DigitalInputConfiguration</a></div> | ||
| <div class="col-last even-row-color all-classes-table all-classes-table-tab2"> | ||
| <div class="block">This class handles the configuration of a digital input component.</div> | ||
| </div> | ||
| <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/opensourcewithslu/utilities/MultiPinConfigs/DigitalInputMultiPinConfiguration.html" title="class in com.opensourcewithslu.utilities.MultiPinConfigs">DigitalInputMultiPinConfiguration</a></div> | ||
| <div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> | ||
| <div class="block">This class handles the configuration of a digital input component that has multiple pins.</div> | ||
| </div> | ||
| <div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/opensourcewithslu/utilities/DigitalOutputConfiguration.html" title="class in com.opensourcewithslu.utilities">DigitalOutputConfiguration</a></div> | ||
| <div class="col-last even-row-color all-classes-table all-classes-table-tab2"> | ||
| <div class="block">This class handles the configuration of a digital output component.</div> | ||
| </div> | ||
| <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/opensourcewithslu/utilities/i2cConfiguration.html" title="class in com.opensourcewithslu.utilities">i2cConfiguration</a></div> | ||
| <div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> | ||
| <div class="block">This class handles the configuration of an I2C components.</div> | ||
| </div> | ||
| <div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/opensourcewithslu/outputdevices/LCD1602Helper.html" title="class in com.opensourcewithslu.outputdevices">LCD1602Helper</a></div> | ||
| <div class="col-last even-row-color all-classes-table all-classes-table-tab2"> | ||
| <div class="block">This helper class, LCD1602Helper, is for controlling and interacting with an I2C LCD1602 display.</div> | ||
| </div> | ||
| <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/opensourcewithslu/outputdevices/LEDHelper.html" title="class in com.opensourcewithslu.outputdevices">LEDHelper</a></div> | ||
| <div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> | ||
| <div class="block">The class LEDHelper contains methods that pertain to the control of a LED.</div> | ||
| </div> | ||
| <div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/opensourcewithslu/utilities/MultipinConfiguration.html" title="class in com.opensourcewithslu.utilities">MultipinConfiguration</a></div> | ||
| <div class="col-last even-row-color all-classes-table all-classes-table-tab2"> | ||
| <div class="block">Class for configuring multipin components.</div> | ||
| </div> | ||
| <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/opensourcewithslu/inputdevices/PhotoResistorHelper.html" title="class in com.opensourcewithslu.inputdevices">PhotoResistorHelper</a></div> | ||
| <div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> | ||
| <div class="block">The PhotoResistorHelper class is used to work with the functionalities of a Photo Resistor.</div> | ||
| </div> | ||
| <div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/opensourcewithslu/utilities/Pi4JFactory.html" title="class in com.opensourcewithslu.utilities">Pi4JFactory</a></div> | ||
| <div class="col-last even-row-color all-classes-table all-classes-table-tab2"> | ||
| <div class="block">The Pi4JFactory class is responsible for creating all the beans for components that are being used.</div> | ||
| </div> | ||
| <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/opensourcewithslu/utilities/Pi4JMultipinFactory.html" title="class in com.opensourcewithslu.utilities">Pi4JMultipinFactory</a></div> | ||
| <div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> | ||
| <div class="block">The Pi4JMultipinFactory class is responsible for creating all the beans for all multi pin components that are being used.</div> | ||
| </div> | ||
| <div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/opensourcewithslu/inputdevices/PIRSensorHelper.html" title="class in com.opensourcewithslu.inputdevices">PIRSensorHelper</a></div> | ||
| <div class="col-last even-row-color all-classes-table all-classes-table-tab2"> | ||
| <div class="block">The PIRSensorHelper class is used to initialize a PIR motion sensor.</div> | ||
| </div> | ||
| <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/opensourcewithslu/inputdevices/PushButtonHelper.html" title="class in com.opensourcewithslu.inputdevices">PushButtonHelper</a></div> | ||
| <div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> | ||
| <div class="block">The PushButtonHelper class is used to create a listener that determines when a 4 pin button is pressed.</div> | ||
| </div> | ||
| <div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/opensourcewithslu/utilities/PwmConfiguration.html" title="class in com.opensourcewithslu.utilities">PwmConfiguration</a></div> | ||
| <div class="col-last even-row-color all-classes-table all-classes-table-tab2"> | ||
| <div class="block">The PwmConfiguration class handles the configuration of a pwm component.</div> | ||
| </div> | ||
| <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/opensourcewithslu/utilities/MultiPinConfigs/PwmMultiPinConfiguration.html" title="class in com.opensourcewithslu.utilities.MultiPinConfigs">PwmMultiPinConfiguration</a></div> | ||
| <div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> | ||
| <div class="block">This class handles the configuration of a PWM device that has multiple pins.</div> | ||
| </div> | ||
| <div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/opensourcewithslu/inputdevices/RFidHelper.html" title="class in com.opensourcewithslu.inputdevices">RFidHelper</a></div> | ||
| <div class="col-last even-row-color all-classes-table all-classes-table-tab2"> | ||
| <div class="block">The RFIDHelper class is for interacting with an RFID scanner.</div> | ||
| </div> | ||
| <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/opensourcewithslu/outputdevices/RGBLEDHelper.html" title="class in com.opensourcewithslu.outputdevices">RGBLEDHelper</a></div> | ||
| <div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> | ||
| <div class="block">The RBGLEDHelper class handles all interactions with a RGB LED.</div> | ||
| </div> | ||
| <div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/opensourcewithslu/inputdevices/RotaryEncoderHelper.html" title="class in com.opensourcewithslu.inputdevices">RotaryEncoderHelper</a></div> | ||
| <div class="col-last even-row-color all-classes-table all-classes-table-tab2"> | ||
| <div class="block">The RotaryEncoderHelper class initializes a rotary encoder component and returns the value of the encoder when called upon.</div> | ||
| </div> | ||
| <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/opensourcewithslu/inputdevices/SlideSwitchHelper.html" title="class in com.opensourcewithslu.inputdevices">SlideSwitchHelper</a></div> | ||
| <div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> | ||
| <div class="block">The SlideSwitchHelper class is used to initialize a slide switch.</div> | ||
| </div> | ||
| <div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/opensourcewithslu/utilities/SpiConfiguration.html" title="class in com.opensourcewithslu.utilities">SpiConfiguration</a></div> | ||
| <div class="col-last even-row-color all-classes-table all-classes-table-tab2"> | ||
| <div class="block">This class handles the configuration of a SPI component.</div> | ||
| </div> | ||
| <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/opensourcewithslu/inputdevices/TouchSwitchHelper.html" title="class in com.opensourcewithslu.inputdevices">TouchSwitchHelper</a></div> | ||
| <div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> | ||
| <div class="block">The TouchSwitchHelper class is used to initialize a touch switch.</div> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </main> | ||
| </div> | ||
| </div> | ||
| </body> | ||
| </html> |
71 changes: 71 additions & 0 deletions
71
pi4micronaut-utils/src/docs/javadoc/allpackages-index.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| <!DOCTYPE HTML> | ||
| <html lang="en"> | ||
| <head> | ||
| <!-- Generated by javadoc (21) --> | ||
| <title>All Packages (pi4micronaut-utils v1.0 API)</title> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1"> | ||
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> | ||
| <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.min.css" title="Style"> | ||
| <script type="text/javascript" src="script.js"></script> | ||
| <script type="text/javascript" src="script-dir/jquery-3.6.1.min.js"></script> | ||
| <script type="text/javascript" src="script-dir/jquery-ui.min.js"></script> | ||
| </head> | ||
| <body class="all-packages-index-page"> | ||
| <script type="text/javascript">var pathtoroot = "./"; | ||
| loadScripts(document, 'script');</script> | ||
| <noscript> | ||
| <div>JavaScript is disabled on your browser.</div> | ||
| </noscript> | ||
| <div class="flex-box"> | ||
| <header role="banner" class="flex-header"> | ||
| <nav role="navigation"> | ||
| <!-- ========= START OF TOP NAVBAR ======= --> | ||
| <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"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button> | ||
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> | ||
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> | ||
| <li><a href="index.html">Overview</a></li> | ||
| <li>Package</li> | ||
| <li>Class</li> | ||
| <li><a href="overview-tree.html">Tree</a></li> | ||
| <li><a href="index-all.html">Index</a></li> | ||
| <li><a href="help-doc.html#all-packages">Help</a></li> | ||
| </ul> | ||
| </div> | ||
| <div class="sub-nav"> | ||
| <div id="navbar-sub-list"></div> | ||
| <div class="nav-list-search"><a href="search.html">SEARCH</a> | ||
| <input type="text" id="search-input" disabled placeholder="Search"> | ||
| <input type="reset" id="reset-button" disabled value="reset"> | ||
| </div> | ||
| </div> | ||
| <!-- ========= END OF TOP NAVBAR ========= --> | ||
| <span class="skip-nav" id="skip-navbar-top"></span></nav> | ||
| </header> | ||
| <div class="flex-content"> | ||
| <main role="main"> | ||
| <div class="header"> | ||
| <h1 title="All&nbsp;Packages" class="title">All Packages</h1> | ||
| </div> | ||
| <div class="caption"><span>Package Summary</span></div> | ||
| <div class="summary-table two-column-summary"> | ||
| <div class="table-header col-first">Package</div> | ||
| <div class="table-header col-last">Description</div> | ||
| <div class="col-first even-row-color"><a href="com/opensourcewithslu/package-summary.html">com.opensourcewithslu</a></div> | ||
| <div class="col-last even-row-color"> </div> | ||
| <div class="col-first odd-row-color"><a href="com/opensourcewithslu/inputdevices/package-summary.html">com.opensourcewithslu.inputdevices</a></div> | ||
| <div class="col-last odd-row-color"> </div> | ||
| <div class="col-first even-row-color"><a href="com/opensourcewithslu/outputdevices/package-summary.html">com.opensourcewithslu.outputdevices</a></div> | ||
| <div class="col-last even-row-color"> </div> | ||
| <div class="col-first odd-row-color"><a href="com/opensourcewithslu/utilities/package-summary.html">com.opensourcewithslu.utilities</a></div> | ||
| <div class="col-last odd-row-color"> </div> | ||
| <div class="col-first even-row-color"><a href="com/opensourcewithslu/utilities/MultiPinConfigs/package-summary.html">com.opensourcewithslu.utilities.MultiPinConfigs</a></div> | ||
| <div class="col-last even-row-color"> </div> | ||
| </div> | ||
| </main> | ||
| </div> | ||
| </div> | ||
| </body> | ||
| </html> |
Oops, something went wrong.