Skip to content

Commit 1284561

Browse files
cowwoccowwoc
committed
Publishing documentation for version 10.12
1 parent 669c5db commit 1284561

File tree

215 files changed

+61274
-0
lines changed

Some content is hidden

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

215 files changed

+61274
-0
lines changed

‎docs/api/10.12/allclasses-index.html

Lines changed: 389 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/api/10.12/allpackages-index.html

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
<!DOCTYPE HTML>
2+
<html lang>
3+
<head>
4+
<!-- Generated by javadoc (21) on Fri Feb 14 00:52:42 UTC 2025 -->
5+
<title>All Packages (Requirements 10.12 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-02-14">
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.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="all-packages-index-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>Module</li>
32+
<li>Package</li>
33+
<li>Class</li>
34+
<li>Use</li>
35+
<li><a href="overview-tree.html">Tree</a></li>
36+
<li><a href="index-all.html">Index</a></li>
37+
<li><a href="help-doc.html#all-packages">Help</a></li>
38+
</ul>
39+
</div>
40+
<div class="sub-nav">
41+
<div id="navbar-sub-list"></div>
42+
<div class="nav-list-search"><a href="search.html">SEARCH</a>
43+
<input type="text" id="search-input" disabled placeholder="Search">
44+
<input type="reset" id="reset-button" disabled value="reset">
45+
</div>
46+
</div>
47+
<!-- ========= END OF TOP NAVBAR ========= -->
48+
<span class="skip-nav" id="skip-navbar-top"></span></nav>
49+
</header>
50+
<div class="flex-content">
51+
<main role="main">
52+
<div class="header">
53+
<h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
54+
</div>
55+
<div class="caption"><span>Package Summary</span></div>
56+
<div class="summary-table two-column-summary">
57+
<div class="table-header col-first">Package</div>
58+
<div class="table-header col-last">Description</div>
59+
<div class="col-first even-row-color"><a href="com.github.cowwoc.requirements10.annotation/com/github/cowwoc/requirements10/annotation/package-summary.html">com.github.cowwoc.requirements10.annotation</a></div>
60+
<div class="col-last even-row-color">&nbsp;</div>
61+
<div class="col-first odd-row-color"><a href="com.github.cowwoc.requirements10.guava/com/github/cowwoc/requirements10/guava/package-summary.html">com.github.cowwoc.requirements10.guava</a></div>
62+
<div class="col-last odd-row-color">
63+
<div class="block">Classes used to verify
64+
<a href="https://en.wikipedia.org/docs/Precondition">preconditions</a>,
65+
<a href="https://en.wikipedia.org/docs/Postcondition">postconditions</a> and
66+
<a href="https://en.wikipedia.org/docs/Invariant_(mathematics)#Invariants_in_computer_science">
67+
invariants</a> of <a href="https://github.com/google/guava">Guava</a> types.</div>
68+
</div>
69+
<div class="col-first even-row-color"><a href="com.github.cowwoc.requirements10.guava/com/github/cowwoc/requirements10/guava/validator/package-summary.html">com.github.cowwoc.requirements10.guava.validator</a></div>
70+
<div class="col-last even-row-color">&nbsp;</div>
71+
<div class="col-first odd-row-color"><a href="com.github.cowwoc.requirements10.jackson/com/github/cowwoc/requirements10/jackson/package-summary.html">com.github.cowwoc.requirements10.jackson</a></div>
72+
<div class="col-last odd-row-color">
73+
<div class="block">Classes used to verify
74+
<a href="https://en.wikipedia.org/docs/Precondition">preconditions</a>,
75+
<a href="https://en.wikipedia.org/docs/Postcondition">postconditions</a> and
76+
<a href="https://en.wikipedia.org/docs/Invariant_(mathematics)#Invariants_in_computer_science">
77+
invariants</a> of <a href="https://github.com/FasterXML/jackson-databind">Jackson</a> types.</div>
78+
</div>
79+
<div class="col-first even-row-color"><a href="com.github.cowwoc.requirements10.jackson/com/github/cowwoc/requirements10/jackson/validator/package-summary.html">com.github.cowwoc.requirements10.jackson.validator</a></div>
80+
<div class="col-last even-row-color">&nbsp;</div>
81+
<div class="col-first odd-row-color"><a href="com.github.cowwoc.requirements10.java/com/github/cowwoc/requirements10/java/package-summary.html">com.github.cowwoc.requirements10.java</a></div>
82+
<div class="col-last odd-row-color">&nbsp;</div>
83+
<div class="col-first even-row-color"><a href="com.github.cowwoc.requirements10.java/com/github/cowwoc/requirements10/java/validator/package-summary.html">com.github.cowwoc.requirements10.java.validator</a></div>
84+
<div class="col-last even-row-color">&nbsp;</div>
85+
<div class="col-first odd-row-color"><a href="com.github.cowwoc.requirements10.java/com/github/cowwoc/requirements10/java/validator/component/package-summary.html">com.github.cowwoc.requirements10.java.validator.component</a></div>
86+
<div class="col-last odd-row-color">&nbsp;</div>
87+
</div>
88+
</main>
89+
<footer role="contentinfo">
90+
<hr>
91+
<p class="legal-copy"><small>Copyright &#169; 2025. All rights reserved.</small></p>
92+
</footer>
93+
</div>
94+
</div>
95+
</body>
96+
</html>

‎docs/api/10.12/com.github.cowwoc.requirements10.annotation/com/github/cowwoc/requirements10/annotation/CheckReturnValue.html

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
<!DOCTYPE HTML>
2+
<html lang>
3+
<head>
4+
<!-- Generated by javadoc (21) on Fri Feb 14 00:52:42 UTC 2025 -->
5+
<title>CheckReturnValue (Requirements 10.12 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-02-14">
9+
<meta name="description" content="declaration: module: com.github.cowwoc.requirements10.annotation, package: com.github.cowwoc.requirements10.annotation, annotation type: CheckReturnValue">
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="../../../../../module-summary.html">Module</a></li>
32+
<li><a href="package-summary.html">Package</a></li>
33+
<li class="nav-bar-cell1-rev">Class</li>
34+
<li><a href="class-use/CheckReturnValue.html">Use</a></li>
35+
<li><a href="package-tree.html">Tree</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>Field</li>
44+
<li>Required</li>
45+
<li>Optional</li>
46+
</ul>
47+
</li>
48+
<li>
49+
<p>Detail:</p>
50+
<ul>
51+
<li>Field</li>
52+
<li>Element</li>
53+
</ul>
54+
</li>
55+
</ul>
56+
</div>
57+
<div class="sub-nav">
58+
<div id="navbar-sub-list">
59+
<ul class="sub-nav-list">
60+
<li>Summary:&nbsp;</li>
61+
<li>Field&nbsp;|&nbsp;</li>
62+
<li>Required&nbsp;|&nbsp;</li>
63+
<li>Optional</li>
64+
</ul>
65+
<ul class="sub-nav-list">
66+
<li>Detail:&nbsp;</li>
67+
<li>Field&nbsp;|&nbsp;</li>
68+
<li>Element</li>
69+
</ul>
70+
</div>
71+
<div class="nav-list-search"><a href="../../../../../../search.html">SEARCH</a>
72+
<input type="text" id="search-input" disabled placeholder="Search">
73+
<input type="reset" id="reset-button" disabled value="reset">
74+
</div>
75+
</div>
76+
<!-- ========= END OF TOP NAVBAR ========= -->
77+
<span class="skip-nav" id="skip-navbar-top"></span></nav>
78+
</header>
79+
<div class="flex-content">
80+
<main role="main">
81+
<!-- ======== START OF CLASS DATA ======== -->
82+
<div class="header">
83+
<div class="sub-title"><span class="module-label-in-type">Module</span>&nbsp;<a href="../../../../../module-summary.html">com.github.cowwoc.requirements10.annotation</a></div>
84+
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">com.github.cowwoc.requirements10.annotation</a></div>
85+
<h1 title="Annotation Interface CheckReturnValue" class="title">Annotation Interface CheckReturnValue</h1>
86+
</div>
87+
<section class="class-description" id="class-description">
88+
<hr>
89+
<div class="type-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/annotation/Target.html" title="class or interface in java.lang.annotation" class="external-link">@Target</a>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/annotation/ElementType.html#METHOD" title="class or interface in java.lang.annotation" class="external-link">METHOD</a>)
90+
</span><span class="modifiers">public @interface </span><span class="element-name type-name-label">CheckReturnValue</span></div>
91+
<div class="block">Indicates that the result of a method call should not be ignored.</div>
92+
</section>
93+
<section class="details" id="annotation-interface-element-detail"></section>
94+
<!-- ========= END OF CLASS DATA ========= -->
95+
</main>
96+
<footer role="contentinfo">
97+
<hr>
98+
<p class="legal-copy"><small>Copyright &#169; 2025. All rights reserved.</small></p>
99+
</footer>
100+
</div>
101+
</div>
102+
</body>
103+
</html>

0 commit comments

Comments
 (0)