thischwa/CloudflareDNS-java
1
0
Fork 0
Code Issues Pull Requests Actions Packages Releases 1 Activity

Refactor code documentation and improve UI accessibility

Browse Source 
Updated JavaDocs for consistency and clarity, modified styling with CSS variables for better maintainability, and enhanced script functionality for interactivity. Minor localization changes and accessibility improvements made to the generated documentation.
This commit is contained in:
Thilo Schwarz
2025-04-19 11:34:22 +02:00
parent 4902d0062a
commit af4e09f938
60 changed files with 3680 additions and 2763 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/apidocs/allclasses-index.html
+38 -42
View File
@@ -1,50 +1,46 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Sun Mar 23 18:51:50 CET 2025 -->
<title>All Classes and Interfaces (CloudflareDNS-java 0.1.0-SNAPSHOT API)</title>
<!-- Generated by javadoc (21) on Sat Apr 19 11:31:09 CEST 2025 -->
<title>Alle Klassen und Schnittstellen (CloudflareDNS-java 0.1.0-SNAPSHOT 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="dc.created" content="2025-03-23">
<meta name="dc.created" content="2025-04-19">
<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">
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.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 evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "./";
<script type="text/javascript">var pathtoroot = "./";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
<div>JavaScript ist im Browser deaktiviert.</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">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Navigationslinks umschalten"><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>
<div class="skip-nav"><a href="#skip-navbar-top" title="Navigations-Links überspringen">Navigations-Links überspringen</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="index.html">Overview</a></li>
<li><a href="index.html">Überblick</a></li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-tree.html">Tree</a></li>
<li>Klasse</li>
<li>Verwendung</li>
<li><a href="overview-tree.html">Baum</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html#all-classes">Help</a></li>
<li><a href="help-doc.html#all-classes">Hilfe</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
<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="Suchen">
<input type="reset" id="reset-button" disabled value="reset">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
@@ -53,84 +49,84 @@ loadScripts(document, 'script');</script>
<div class="flex-content">
<main role="main">
<div class="header">
<h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces</h1>
<h1 title="Alle Klassen und Schnittstellen" class="title">Alle Klassen und Schnittstellen</h1>
</div>
<div id="all-classes-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="all-classes-table-tab0" role="tab" aria-selected="true" aria-controls="all-classes-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="all-classes-table-tab1" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab1', 2)" class="table-tab">Interfaces</button><button id="all-classes-table-tab2" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab2', 2)" class="table-tab">Classes</button><button id="all-classes-table-tab3" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab3', 2)" class="table-tab">Enum Classes</button><button id="all-classes-table-tab5" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab5', 2)" class="table-tab">Exceptions</button></div>
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="all-classes-table-tab0" role="tab" aria-selected="true" aria-controls="all-classes-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table', 2)" class="active-table-tab">Alle Klassen und Schnittstellen</button><button id="all-classes-table-tab1" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab1', 2)" class="table-tab">Schnittstellen</button><button id="all-classes-table-tab2" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab2', 2)" class="table-tab">Klassen</button><button id="all-classes-table-tab3" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab3', 2)" class="table-tab">Enum-Klassen</button><button id="all-classes-table-tab5" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab5', 2)" class="table-tab">Ausnahmeklassen</button></div>
<div id="all-classes-table.tabpanel" role="tabpanel" aria-labelledby="all-classes-table-tab0">
<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="codes/thischwa/cf/model/AbstractEntity.html" title="class in codes.thischwa.cf.model">AbstractEntity</a></div>
<div class="table-header col-first">Klasse</div>
<div class="table-header col-last">Beschreibung</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="codes/thischwa/cf/model/AbstractEntity.html" title="Klasse in codes.thischwa.cf.model">AbstractEntity</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Represents a base abstract entity class for modeling domain objects with a unique identifier.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="codes/thischwa/cf/model/AbstractMultipleResponse.html" title="class in codes.thischwa.cf.model">AbstractMultipleResponse</a>&lt;<a href="codes/thischwa/cf/model/AbstractMultipleResponse.html" title="type parameter in AbstractMultipleResponse">T</a> extends <a href="codes/thischwa/cf/model/ResponseEntity.html" title="interface in codes.thischwa.cf.model">ResponseEntity</a>&gt;</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="codes/thischwa/cf/model/AbstractMultipleResponse.html" title="Klasse in codes.thischwa.cf.model">AbstractMultipleResponse&lt;T&gt;</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Abstract base class for response models that contain multiple result entries.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="codes/thischwa/cf/model/AbstractResponse.html" title="class in codes.thischwa.cf.model">AbstractResponse</a></div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="codes/thischwa/cf/model/AbstractResponse.html" title="Klasse in codes.thischwa.cf.model">AbstractResponse</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Abstract base class for API response models.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="codes/thischwa/cf/model/AbstractSingleResponse.html" title="class in codes.thischwa.cf.model">AbstractSingleResponse</a>&lt;<a href="codes/thischwa/cf/model/AbstractSingleResponse.html" title="type parameter in AbstractSingleResponse">T</a> extends <a href="codes/thischwa/cf/model/ResponseEntity.html" title="interface in codes.thischwa.cf.model">ResponseEntity</a>&gt;</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="codes/thischwa/cf/model/AbstractSingleResponse.html" title="Klasse in codes.thischwa.cf.model">AbstractSingleResponse&lt;T&gt;</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Represents a base abstract response model for handling single response entities within an API
response.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="codes/thischwa/cf/CfDnsClient.html" title="class in codes.thischwa.cf">CfDnsClient</a></div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="codes/thischwa/cf/CfDnsClient.html" title="Klasse in codes.thischwa.cf">CfDnsClient</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">CfDnsClient is a client interface to interact with Cloudflare DNS service.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="codes/thischwa/cf/CfRequest.html" title="enum class in codes.thischwa.cf">CfRequest</a></div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="codes/thischwa/cf/CfRequest.html" title="Enum-Klasse in codes.thischwa.cf">CfRequest</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab3">
<div class="block">Enum CfRequest encapsulates various API endpoint paths for managing DNS zones and records in a
cohesive and reusable manner.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab5"><a href="codes/thischwa/cf/CloudflareApiException.html" title="class in codes.thischwa.cf">CloudflareApiException</a></div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab5"><a href="codes/thischwa/cf/CloudflareApiException.html" title="Klasse in codes.thischwa.cf">CloudflareApiException</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab5">
<div class="block">Represents a custom exception for errors encountered while interacting with the Cloudflare API.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab5"><a href="codes/thischwa/cf/CloudflareNotFoundException.html" title="class in codes.thischwa.cf">CloudflareNotFoundException</a></div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab5"><a href="codes/thischwa/cf/CloudflareNotFoundException.html" title="Klasse in codes.thischwa.cf">CloudflareNotFoundException</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab5">
<div class="block">This exception is thrown to indicate that a requested resource was not found during interaction
with the Cloudflare API.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="codes/thischwa/cf/model/PagingRequest.html" title="class in codes.thischwa.cf.model">PagingRequest</a></div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="codes/thischwa/cf/model/PagingRequest.html" title="Klasse in codes.thischwa.cf.model">PagingRequest</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Represents a request model for paginated data.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="codes/thischwa/cf/model/RecordEntity.html" title="class in codes.thischwa.cf.model">RecordEntity</a></div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="codes/thischwa/cf/model/RecordEntity.html" title="Klasse in codes.thischwa.cf.model">RecordEntity</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Represents a DNS record entity within a specific zone.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="codes/thischwa/cf/model/RecordMultipleResponse.html" title="class in codes.thischwa.cf.model">RecordMultipleResponse</a></div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="codes/thischwa/cf/model/RecordMultipleResponse.html" title="Klasse in codes.thischwa.cf.model">RecordMultipleResponse</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Represents the API response of the Cloudflare API containing multiple DNS record entities.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="codes/thischwa/cf/model/RecordSingleResponse.html" title="class in codes.thischwa.cf.model">RecordSingleResponse</a></div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="codes/thischwa/cf/model/RecordSingleResponse.html" title="Klasse in codes.thischwa.cf.model">RecordSingleResponse</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Represents the API response of the Cloudflare API containing a single DNS record entity.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab3"><a href="codes/thischwa/cf/model/RecordType.html" title="enum class in codes.thischwa.cf.model">RecordType</a></div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab3"><a href="codes/thischwa/cf/model/RecordType.html" title="Enum-Klasse in codes.thischwa.cf.model">RecordType</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab3">
<div class="block">Enum representing various DNS record types.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="codes/thischwa/cf/model/ResponseEntity.html" title="interface in codes.thischwa.cf.model">ResponseEntity</a></div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="codes/thischwa/cf/model/ResponseEntity.html" title="Schnittstelle in codes.thischwa.cf.model">ResponseEntity</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
<div class="block">Represents a contract for entities that have a unique identifier.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="codes/thischwa/cf/model/ResultInfo.html" title="class in codes.thischwa.cf.model">ResultInfo</a></div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="codes/thischwa/cf/model/ResultInfo.html" title="Klasse in codes.thischwa.cf.model">ResultInfo</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Represents metadata for paginated results.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="codes/thischwa/cf/model/ZoneEntity.html" title="class in codes.thischwa.cf.model">ZoneEntity</a></div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="codes/thischwa/cf/model/ZoneEntity.html" title="Klasse in codes.thischwa.cf.model">ZoneEntity</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Represents a DNS zone entity in the Cloudflare DNS system.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="codes/thischwa/cf/model/ZoneMultipleResponse.html" title="class in codes.thischwa.cf.model">ZoneMultipleResponse</a></div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="codes/thischwa/cf/model/ZoneMultipleResponse.html" title="Klasse in codes.thischwa.cf.model">ZoneMultipleResponse</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Represents a response model that contains multiple <a href="codes/thischwa/cf/model/ZoneEntity.html" title="class in codes.thischwa.cf.model"><code>ZoneEntity</code></a> instances.</div>
<div class="block">Represents a response model that contains multiple <a href="codes/thischwa/cf/model/ZoneEntity.html" title="Klasse in codes.thischwa.cf.model"><code>ZoneEntity</code></a> instances.</div>
</div>
</div>
</div>