Skip to content

Commit 00da4a1

Browse files
kevmookevmoo
committed
regenerate docs
1 parent 1ed3422 commit 00da4a1

File tree

143 files changed

+1243
-571
lines changed

Some content is hidden

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

143 files changed

+1243
-571
lines changed

‎testing/test_package_docs/ex/Animal-class.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ <h2>Properties</h2>
210210
<span class="signature">&#8594; int</span>
211211
</dt>
212212
<dd class="inherited">
213-
<p>Get a hash code for this object.</p>
213+
<p>The hash code for this object.</p>
214214
<div class="features">read-only, inherited</div>
215215
</dd>
216216
<dt id="runtimeType" class="property inherited">

‎testing/test_package_docs/ex/Apple-class.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ <h2>Properties</h2>
246246
<span class="signature">&#8594; int</span>
247247
</dt>
248248
<dd class="inherited">
249-
<p>Get a hash code for this object.</p>
249+
<p>The hash code for this object.</p>
250250
<div class="features">read-only, inherited</div>
251251
</dd>
252252
<dt id="runtimeType" class="property inherited">

‎testing/test_package_docs/ex/Apple/hashCode.html‎

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -120,14 +120,28 @@ <h5><a href="ex/Apple-class.html">Apple</a></h5>
120120
<span class="name ">hashCode</span></section>
121121

122122
<section class="desc markdown">
123-
<p>Get a hash code for this object.</p>
124-
<p>All objects have hash codes. Hash codes are guaranteed to be the
125-
same for objects that are equal when compared using the equality
126-
operator <code>==</code>. Other than that there are no guarantees about
127-
the hash codes. They will not be consistent between runs and
128-
there are no distribution guarantees.</p>
129-
<p>If a subclass overrides <code>hashCode</code> it should override the
130-
equality operator as well to maintain consistency.</p>
123+
<p>The hash code for this object.</p>
124+
<p>A hash code is a single integer which represents the state of the object
125+
that affects <code>==</code> comparisons.</p>
126+
<p>All objects have hash codes.
127+
The default hash code represents only the identity of the object,
128+
the same way as the default <code>==</code> implementation only considers objects
129+
equal if they are identical (see <code>identityHashCode</code>).</p>
130+
<p>If <code>==</code> is overridden to use the object state instead,
131+
the hash code must also be changed to represent that state. </p>
132+
<p>Hash codes must be the same for objects that are equal to each other
133+
according to <code>==</code>.
134+
The hash code of an object should only change if the object changes
135+
in a way that affects equality.
136+
There are no further requirements for the hash codes.
137+
They need not be consistent between executions of the same program
138+
and there are no distribution guarantees.</p>
139+
<p>Objects that are not equal are allowed to have the same hash code,
140+
it is even technically allowed that all instances have the same hash code,
141+
but if clashes happen too often, it may reduce the efficiency of hash-based
142+
data structures like <code>HashSet</code> or <code>HashMap</code>.</p>
143+
<p>If a subclass overrides <code>hashCode</code>, it should override the
144+
<code>==</code> operator as well to maintain consistency.</p>
131145
</section>
132146
</section>
133147

‎testing/test_package_docs/ex/Apple/operator_equals.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -129,9 +129,9 @@ <h5><a href="ex/Apple-class.html">Apple</a></h5>
129129
either both be true, or both be false.</p></li><li>
130130
<p>Transitive: For all objects <code>o1</code>, <code>o2</code>, and <code>o3</code>, if <code>o1 == o2</code> and
131131
<code>o2 == o3</code> are true, then <code>o1 == o3</code> must be true.</p></li></ul>
132-
<p>The method should also be consistent over time, so equality of two objects
133-
should not change over time, or at least only change if one of the objects
134-
was modified.</p>
132+
<p>The method should also be consistent over time,
133+
so whether two objects are equal should only change
134+
if at least one of the objects was modified.</p>
135135
<p>If a subclass overrides the equality operator it should override
136136
the <code>hashCode</code> method as well to maintain consistency.</p>
137137
</section>

‎testing/test_package_docs/ex/B-class.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ <h2>Properties</h2>
229229
<span class="signature">&#8594; int</span>
230230
</dt>
231231
<dd class="inherited">
232-
<p>Get a hash code for this object.</p>
232+
<p>The hash code for this object.</p>
233233
<div class="features">read-only, inherited</div>
234234
</dd>
235235
<dt id="m" class="property inherited">

‎testing/test_package_docs/ex/B/hashCode.html‎

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -122,14 +122,28 @@ <h5><a href="ex/B-class.html">B</a></h5>
122122
<span class="name ">hashCode</span></section>
123123

124124
<section class="desc markdown">
125-
<p>Get a hash code for this object.</p>
126-
<p>All objects have hash codes. Hash codes are guaranteed to be the
127-
same for objects that are equal when compared using the equality
128-
operator <code>==</code>. Other than that there are no guarantees about
129-
the hash codes. They will not be consistent between runs and
130-
there are no distribution guarantees.</p>
131-
<p>If a subclass overrides <code>hashCode</code> it should override the
132-
equality operator as well to maintain consistency.</p>
125+
<p>The hash code for this object.</p>
126+
<p>A hash code is a single integer which represents the state of the object
127+
that affects <code>==</code> comparisons.</p>
128+
<p>All objects have hash codes.
129+
The default hash code represents only the identity of the object,
130+
the same way as the default <code>==</code> implementation only considers objects
131+
equal if they are identical (see <code>identityHashCode</code>).</p>
132+
<p>If <code>==</code> is overridden to use the object state instead,
133+
the hash code must also be changed to represent that state. </p>
134+
<p>Hash codes must be the same for objects that are equal to each other
135+
according to <code>==</code>.
136+
The hash code of an object should only change if the object changes
137+
in a way that affects equality.
138+
There are no further requirements for the hash codes.
139+
They need not be consistent between executions of the same program
140+
and there are no distribution guarantees.</p>
141+
<p>Objects that are not equal are allowed to have the same hash code,
142+
it is even technically allowed that all instances have the same hash code,
143+
but if clashes happen too often, it may reduce the efficiency of hash-based
144+
data structures like <code>HashSet</code> or <code>HashMap</code>.</p>
145+
<p>If a subclass overrides <code>hashCode</code>, it should override the
146+
<code>==</code> operator as well to maintain consistency.</p>
133147
</section>
134148
</section>
135149

‎testing/test_package_docs/ex/B/operator_equals.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -131,9 +131,9 @@ <h5><a href="ex/B-class.html">B</a></h5>
131131
either both be true, or both be false.</p></li><li>
132132
<p>Transitive: For all objects <code>o1</code>, <code>o2</code>, and <code>o3</code>, if <code>o1 == o2</code> and
133133
<code>o2 == o3</code> are true, then <code>o1 == o3</code> must be true.</p></li></ul>
134-
<p>The method should also be consistent over time, so equality of two objects
135-
should not change over time, or at least only change if one of the objects
136-
was modified.</p>
134+
<p>The method should also be consistent over time,
135+
so whether two objects are equal should only change
136+
if at least one of the objects was modified.</p>
137137
<p>If a subclass overrides the equality operator it should override
138138
the <code>hashCode</code> method as well to maintain consistency.</p>
139139
</section>

‎testing/test_package_docs/ex/Cat-class.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ <h2>Properties</h2>
187187
<span class="signature">&#8594; int</span>
188188
</dt>
189189
<dd class="inherited">
190-
<p>Get a hash code for this object.</p>
190+
<p>The hash code for this object.</p>
191191
<div class="features">read-only, inherited</div>
192192
</dd>
193193
<dt id="runtimeType" class="property inherited">

‎testing/test_package_docs/ex/Cat/hashCode.html‎

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -107,14 +107,28 @@ <h5><a href="ex/Cat-class.html">Cat</a></h5>
107107
<span class="name ">hashCode</span></section>
108108

109109
<section class="desc markdown">
110-
<p>Get a hash code for this object.</p>
111-
<p>All objects have hash codes. Hash codes are guaranteed to be the
112-
same for objects that are equal when compared using the equality
113-
operator <code>==</code>. Other than that there are no guarantees about
114-
the hash codes. They will not be consistent between runs and
115-
there are no distribution guarantees.</p>
116-
<p>If a subclass overrides <code>hashCode</code> it should override the
117-
equality operator as well to maintain consistency.</p>
110+
<p>The hash code for this object.</p>
111+
<p>A hash code is a single integer which represents the state of the object
112+
that affects <code>==</code> comparisons.</p>
113+
<p>All objects have hash codes.
114+
The default hash code represents only the identity of the object,
115+
the same way as the default <code>==</code> implementation only considers objects
116+
equal if they are identical (see <code>identityHashCode</code>).</p>
117+
<p>If <code>==</code> is overridden to use the object state instead,
118+
the hash code must also be changed to represent that state. </p>
119+
<p>Hash codes must be the same for objects that are equal to each other
120+
according to <code>==</code>.
121+
The hash code of an object should only change if the object changes
122+
in a way that affects equality.
123+
There are no further requirements for the hash codes.
124+
They need not be consistent between executions of the same program
125+
and there are no distribution guarantees.</p>
126+
<p>Objects that are not equal are allowed to have the same hash code,
127+
it is even technically allowed that all instances have the same hash code,
128+
but if clashes happen too often, it may reduce the efficiency of hash-based
129+
data structures like <code>HashSet</code> or <code>HashMap</code>.</p>
130+
<p>If a subclass overrides <code>hashCode</code>, it should override the
131+
<code>==</code> operator as well to maintain consistency.</p>
118132
</section>
119133
</section>
120134

‎testing/test_package_docs/ex/Cat/operator_equals.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -116,9 +116,9 @@ <h5><a href="ex/Cat-class.html">Cat</a></h5>
116116
either both be true, or both be false.</p></li><li>
117117
<p>Transitive: For all objects <code>o1</code>, <code>o2</code>, and <code>o3</code>, if <code>o1 == o2</code> and
118118
<code>o2 == o3</code> are true, then <code>o1 == o3</code> must be true.</p></li></ul>
119-
<p>The method should also be consistent over time, so equality of two objects
120-
should not change over time, or at least only change if one of the objects
121-
was modified.</p>
119+
<p>The method should also be consistent over time,
120+
so whether two objects are equal should only change
121+
if at least one of the objects was modified.</p>
122122
<p>If a subclass overrides the equality operator it should override
123123
the <code>hashCode</code> method as well to maintain consistency.</p>
124124
</section>

0 commit comments

Comments
 (0)