Skip to content

Commit

Permalink
Update javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
@Carleslc
Carleslc committed Feb 3, 2022
1 parent 7b883dc commit bc9c30d
Show file tree
Hide file tree
Showing 315 changed files with 140,459 additions and 12 deletions.
19 changes: 10 additions & 9 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ If you are using Maven you do not need to download the jar. Instead, add this re
<dependency>
<groupId>me.carleslc.Simple-YAML</groupId>
<artifactId>Simple-Yaml</artifactId>
<version>1.7.2</version>
<version>1.7.3</version>
</dependency>
```

Expand All @@ -62,7 +62,7 @@ If you are using Maven you do not need to download the jar. Instead, add this re
<dependency>
<groupId>me.carleslc.Simple-YAML</groupId>
<artifactId>Simple-Configuration</artifactId>
<version>1.7.2</version>
<version>1.7.3</version>
</dependency>
```

Expand All @@ -85,7 +85,7 @@ allprojects {

```gradle
dependencies {
implementation 'me.carleslc.Simple-YAML:Simple-Yaml:1.7.2'
implementation 'me.carleslc.Simple-YAML:Simple-Yaml:1.7.3'
}
```

Expand All @@ -96,7 +96,7 @@ dependencies {

```gradle
dependencies {
implementation 'me.carleslc.Simple-YAML:Simple-Configuration:1.7.2'
implementation 'me.carleslc.Simple-YAML:Simple-Configuration:1.7.3'
}
```

Expand All @@ -118,16 +118,17 @@ Example `.yml` files [here](https://github.com/Carleslc/Simple-YAML/tree/master/

For more information and methods see the **Javadoc**:

- [Simple-Yaml](https://carleslc.me/Simple-YAML/doc/Simple-Yaml)
- [Simple-Configuration](https://carleslc.me/Simple-YAML/doc/Simple-Configuration)
- [Simple-YAML](https://carleslc.me/Simple-YAML/doc)
- [Simple-Yaml](https://carleslc.me/Simple-YAML/doc/Simple-Yaml)
- [Simple-Configuration](https://carleslc.me/Simple-YAML/doc/Simple-Configuration)

## Dependencies

This API uses _SnakeYAML_, which is already included in the [latest Simple-Yaml.jar](https://github.com/Carleslc/Simple-YAML/releases), so you don't have to worry about anything more than putting up the jar as a dependency on your project.

* [SnakeYAML](https://bitbucket.org/asomov/snakeyaml)
+ [Javadoc](http://javadox.com/org.yaml/snakeyaml/1.15/overview-summary.html)
+ [Documentation](https://bitbucket.org/asomov/snakeyaml/wiki/Documentation)
* [SnakeYAML](https://bitbucket.org/snakeyaml/snakeyaml)
+ [Javadoc](https://javadoc.io/doc/org.yaml/snakeyaml/latest/index.html)
+ [Documentation](https://bitbucket.org/snakeyaml/snakeyaml/wiki/Documentation)

## Looking for other file type configurations?

Expand Down
37 changes: 37 additions & 0 deletions doc/Simple-Configuration/allclasses-frame.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="es">
<head>
<!-- Generated by javadoc (1.8.0_212) on Thu Feb 03 22:42:36 CET 2022 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>All Classes (Simple-Configuration 1.7.3 API)</title>
<meta name="date" content="2022-02-03">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
<body>
<h1 class="bar">All&nbsp;Classes</h1>
<div class="indexContainer">
<ul>
<li><a href="org/simpleyaml/configuration/comments/Commentable.html" title="interface in org.simpleyaml.configuration.comments" target="classFrame"><span class="interfaceName">Commentable</span></a></li>
<li><a href="org/simpleyaml/configuration/comments/CommentType.html" title="enum in org.simpleyaml.configuration.comments" target="classFrame">CommentType</a></li>
<li><a href="org/simpleyaml/configuration/Configuration.html" title="interface in org.simpleyaml.configuration" target="classFrame"><span class="interfaceName">Configuration</span></a></li>
<li><a href="org/simpleyaml/configuration/ConfigurationOptions.html" title="class in org.simpleyaml.configuration" target="classFrame">ConfigurationOptions</a></li>
<li><a href="org/simpleyaml/configuration/ConfigurationSection.html" title="interface in org.simpleyaml.configuration" target="classFrame"><span class="interfaceName">ConfigurationSection</span></a></li>
<li><a href="org/simpleyaml/configuration/serialization/ConfigurationSerializable.html" title="interface in org.simpleyaml.configuration.serialization" target="classFrame"><span class="interfaceName">ConfigurationSerializable</span></a></li>
<li><a href="org/simpleyaml/configuration/serialization/ConfigurationSerialization.html" title="class in org.simpleyaml.configuration.serialization" target="classFrame">ConfigurationSerialization</a></li>
<li><a href="org/simpleyaml/configuration/serialization/DelegateDeserialization.html" title="annotation in org.simpleyaml.configuration.serialization" target="classFrame">DelegateDeserialization</a></li>
<li><a href="org/simpleyaml/configuration/file/FileConfiguration.html" title="class in org.simpleyaml.configuration.file" target="classFrame">FileConfiguration</a></li>
<li><a href="org/simpleyaml/configuration/file/FileConfigurationOptions.html" title="class in org.simpleyaml.configuration.file" target="classFrame">FileConfigurationOptions</a></li>
<li><a href="org/simpleyaml/exceptions/InvalidConfigurationException.html" title="class in org.simpleyaml.exceptions" target="classFrame">InvalidConfigurationException</a></li>
<li><a href="org/simpleyaml/configuration/comments/KeyTree.html" title="class in org.simpleyaml.configuration.comments" target="classFrame">KeyTree</a></li>
<li><a href="org/simpleyaml/configuration/MemoryConfiguration.html" title="class in org.simpleyaml.configuration" target="classFrame">MemoryConfiguration</a></li>
<li><a href="org/simpleyaml/configuration/MemoryConfigurationOptions.html" title="class in org.simpleyaml.configuration" target="classFrame">MemoryConfigurationOptions</a></li>
<li><a href="org/simpleyaml/configuration/MemorySection.html" title="class in org.simpleyaml.configuration" target="classFrame">MemorySection</a></li>
<li><a href="org/simpleyaml/utils/NumberConversions.html" title="class in org.simpleyaml.utils" target="classFrame">NumberConversions</a></li>
<li><a href="org/simpleyaml/configuration/serialization/SerializableAs.html" title="annotation in org.simpleyaml.configuration.serialization" target="classFrame">SerializableAs</a></li>
<li><a href="org/simpleyaml/utils/Validate.html" title="class in org.simpleyaml.utils" target="classFrame">Validate</a></li>
</ul>
</div>
</body>
</html>
243 changes: 243 additions & 0 deletions doc/Simple-Configuration/allclasses-index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,243 @@
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="es">
<head>
<!-- Generated by javadoc (12.0.1) on Thu Feb 03 21:18:04 CET 2022 -->
<title>All Classes (Simple-Configuration 1.7.3 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-02-03">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="script.js"></script>
<script type="text/javascript" src="jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="All Classes (Simple-Configuration 1.7.3 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":1,"i1":4,"i2":1,"i3":2,"i4":1,"i5":1,"i6":2,"i7":32,"i8":2,"i9":2,"i10":8,"i11":2,"i12":2,"i13":2,"i14":2,"i15":2,"i16":32,"i17":2};
var tabs = {65535:["t0","All Classes"],1:["t1","Interface Summary"],2:["t2","Class Summary"],4:["t3","Enum Summary"],8:["t4","Exception Summary"],32:["t6","Annotation Types Summary"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "./";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= 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">
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<main role="main">
<div class="header">
<h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
</div>
<div class="allClassesContainer">
<ul class="blockList">
<li class="blockList">
<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><button role="tab" aria-selected="false" aria-controls="typeSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t6" class="tableTab" onclick="show(32);">Annotation Types Summary</button></div>
<div id="typeSummary_tabpanel" role="tabpanel">
<table aria-labelledby="t0">
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor" id="i0">
<td class="colFirst"><a href="org/simpleyaml/configuration/comments/Commentable.html" title="interface in org.simpleyaml.configuration.comments">Commentable</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><a href="org/simpleyaml/configuration/comments/CommentType.html" title="enum in org.simpleyaml.configuration.comments">CommentType</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><a href="org/simpleyaml/configuration/Configuration.html" title="interface in org.simpleyaml.configuration">Configuration</a></td>
<th class="colLast" scope="row">
<div class="block">Represents a source of configurable options and settings</div>
</th>
</tr>
<tr class="rowColor" id="i3">
<td class="colFirst"><a href="org/simpleyaml/configuration/ConfigurationOptions.html" title="class in org.simpleyaml.configuration">ConfigurationOptions</a></td>
<th class="colLast" scope="row">
<div class="block">Various settings for controlling the input and output of a <a href="org/simpleyaml/configuration/Configuration.html" title="interface in org.simpleyaml.configuration"><code>Configuration</code></a></div>
</th>
</tr>
<tr class="altColor" id="i4">
<td class="colFirst"><a href="org/simpleyaml/configuration/ConfigurationSection.html" title="interface in org.simpleyaml.configuration">ConfigurationSection</a></td>
<th class="colLast" scope="row">
<div class="block">Represents a section of a <a href="org/simpleyaml/configuration/Configuration.html" title="interface in org.simpleyaml.configuration"><code>Configuration</code></a></div>
</th>
</tr>
<tr class="rowColor" id="i5">
<td class="colFirst"><a href="org/simpleyaml/configuration/serialization/ConfigurationSerializable.html" title="interface in org.simpleyaml.configuration.serialization">ConfigurationSerializable</a></td>
<th class="colLast" scope="row">
<div class="block">Represents an object that may be serialized.</div>
</th>
</tr>
<tr class="altColor" id="i6">
<td class="colFirst"><a href="org/simpleyaml/configuration/serialization/ConfigurationSerialization.html" title="class in org.simpleyaml.configuration.serialization">ConfigurationSerialization</a></td>
<th class="colLast" scope="row">
<div class="block">Utility class for storing and retrieving classes for <a href="org/simpleyaml/configuration/Configuration.html" title="interface in org.simpleyaml.configuration"><code>Configuration</code></a>.</div>
</th>
</tr>
<tr class="rowColor" id="i7">
<td class="colFirst"><a href="org/simpleyaml/configuration/serialization/DelegateDeserialization.html" title="annotation in org.simpleyaml.configuration.serialization">DelegateDeserialization</a></td>
<th class="colLast" scope="row">
<div class="block">Applies to a <a href="org/simpleyaml/configuration/serialization/ConfigurationSerializable.html" title="interface in org.simpleyaml.configuration.serialization"><code>ConfigurationSerializable</code></a> that will delegate all
deserialization to another <a href="org/simpleyaml/configuration/serialization/ConfigurationSerializable.html" title="interface in org.simpleyaml.configuration.serialization"><code>ConfigurationSerializable</code></a>.</div>
</th>
</tr>
<tr class="altColor" id="i8">
<td class="colFirst"><a href="org/simpleyaml/configuration/file/FileConfiguration.html" title="class in org.simpleyaml.configuration.file">FileConfiguration</a></td>
<th class="colLast" scope="row">
<div class="block">This is a base class for all File based implementations of <a href="org/simpleyaml/configuration/Configuration.html" title="interface in org.simpleyaml.configuration"><code>Configuration</code></a></div>
</th>
</tr>
<tr class="rowColor" id="i9">
<td class="colFirst"><a href="org/simpleyaml/configuration/file/FileConfigurationOptions.html" title="class in org.simpleyaml.configuration.file">FileConfigurationOptions</a></td>
<th class="colLast" scope="row">
<div class="block">Various settings for controlling the input and output of a <a href="org/simpleyaml/configuration/file/FileConfiguration.html" title="class in org.simpleyaml.configuration.file"><code>FileConfiguration</code></a></div>
</th>
</tr>
<tr class="altColor" id="i10">
<td class="colFirst"><a href="org/simpleyaml/exceptions/InvalidConfigurationException.html" title="class in org.simpleyaml.exceptions">InvalidConfigurationException</a></td>
<th class="colLast" scope="row">
<div class="block">Exception thrown when attempting to load an invalid <a href="org/simpleyaml/configuration/Configuration.html" title="interface in org.simpleyaml.configuration"><code>Configuration</code></a></div>
</th>
</tr>
<tr class="rowColor" id="i11">
<td class="colFirst"><a href="org/simpleyaml/configuration/comments/KeyTree.html" title="class in org.simpleyaml.configuration.comments">KeyTree</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr class="altColor" id="i12">
<td class="colFirst"><a href="org/simpleyaml/configuration/MemoryConfiguration.html" title="class in org.simpleyaml.configuration">MemoryConfiguration</a></td>
<th class="colLast" scope="row">
<div class="block">This is a <a href="org/simpleyaml/configuration/Configuration.html" title="interface in org.simpleyaml.configuration"><code>Configuration</code></a> implementation that does not save or load
from any source, and stores all values in memory only.</div>
</th>
</tr>
<tr class="rowColor" id="i13">
<td class="colFirst"><a href="org/simpleyaml/configuration/MemoryConfigurationOptions.html" title="class in org.simpleyaml.configuration">MemoryConfigurationOptions</a></td>
<th class="colLast" scope="row">
<div class="block">Various settings for controlling the input and output of a <a href="org/simpleyaml/configuration/MemoryConfiguration.html" title="class in org.simpleyaml.configuration"><code>MemoryConfiguration</code></a></div>
</th>
</tr>
<tr class="altColor" id="i14">
<td class="colFirst"><a href="org/simpleyaml/configuration/MemorySection.html" title="class in org.simpleyaml.configuration">MemorySection</a></td>
<th class="colLast" scope="row">
<div class="block">A type of <a href="org/simpleyaml/configuration/ConfigurationSection.html" title="interface in org.simpleyaml.configuration"><code>ConfigurationSection</code></a> that is stored in memory.</div>
</th>
</tr>
<tr class="rowColor" id="i15">
<td class="colFirst"><a href="org/simpleyaml/utils/NumberConversions.html" title="class in org.simpleyaml.utils">NumberConversions</a></td>
<th class="colLast" scope="row">
<div class="block">Utils for casting number types to other number types</div>
</th>
</tr>
<tr class="altColor" id="i16">
<td class="colFirst"><a href="org/simpleyaml/configuration/serialization/SerializableAs.html" title="annotation in org.simpleyaml.configuration.serialization">SerializableAs</a></td>
<th class="colLast" scope="row">
<div class="block">Represents an "alias" that a <a href="org/simpleyaml/configuration/serialization/ConfigurationSerializable.html" title="interface in org.simpleyaml.configuration.serialization"><code>ConfigurationSerializable</code></a> may be
stored as.</div>
</th>
</tr>
<tr class="rowColor" id="i17">
<td class="colFirst"><a href="org/simpleyaml/utils/Validate.html" title="class in org.simpleyaml.utils">Validate</a></td>
<th class="colLast" scope="row">
<div class="block">This class assists in validating arguments.</div>
</th>
</tr>
</tbody>
</table>
</div>
</div>
</li>
</ul>
</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; 2022. All rights reserved.</small></p>
</footer>
</body>
</html>
Loading

0 comments on commit bc9c30d

Please sign in to comment.