Skip to content

Commit 127bd52

Browse files
garydgregorygarydgregory
committed
Use Javadoc instead of HTML tag
1 parent 0de87e0 commit 127bd52

File tree

20 files changed

+107
-107
lines changed

20 files changed

+107
-107
lines changed

‎commons-rdf-api/src/main/java/org/apache/commons/rdf/api/BlankNode.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ public interface BlankNode extends BlankNodeOrIRI {
9999
* or from different {@link RDF} instances MUST NOT have the same reference
100100
* string.
101101
* <p>
102-
* The {@link #uniqueReference()} of two <code>BlankNode</code> instances
102+
* The {@link #uniqueReference()} of two {@code BlankNode} instances
103103
* MUST be equal if and only if the two blank nodes are equal according to
104104
* {@link #equals(Object)}.
105105
* <p>

‎commons-rdf-api/src/main/java/org/apache/commons/rdf/api/Dataset.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,8 +131,8 @@ default void close() throws Exception {
131131
* <p>
132132
* The {@link Triple}s of the named graph are equivalent to the Quads of
133133
* this Dataset which has the {@link Quad#getGraphName()} equal to the
134-
* provided <code>graphName</code>, or equal to {@link Optional#empty()} if
135-
* the provided <code>graphName</code> is {@code null}.
134+
* provided {@code graphName}, or equal to {@link Optional#empty()} if
135+
* the provided {@code graphName} is {@code null}.
136136
* <p>
137137
* It is unspecified if modifications to the returned Graph are reflected in
138138
* this Dataset.

‎commons-rdf-api/src/main/java/org/apache/commons/rdf/api/Literal.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ public interface Literal extends RDFTerm {
128128
* The returned hash code MUST be equal to the result of
129129
* {@link Objects#hash(Object...)} with the arguments
130130
* {@link #getLexicalForm()}, {@link #getDatatype()},
131-
* {@link #getLanguageTag()}<code>.map(s-&gt;s.toLowerString(Locale.ROOT))</code>.
131+
* {@link #getLanguageTag()}{@code .map(s-&gt;s.toLowerString(Locale.ROOT))}.
132132
* <p>
133133
* This method MUST be implemented in conjunction with
134134
* {@link #equals(Object)} so that two equal Literals produce the same hash

‎commons-rdf-api/src/main/java/org/apache/commons/rdf/api/Quad.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,27 +28,27 @@
2828
* >RDF-1.1 Concepts and Abstract Syntax</a>, a W3C Working Group Note published
2929
* on 25 February 2014.
3030
* <p>
31-
* A <code>Quad</code> object in Commons RDF is considered
31+
* A {@code Quad} object in Commons RDF is considered
3232
* <strong>immutable</strong>, that is, over its life time it will have
3333
* consistent behavior for its {@link #equals(Object)}, and the instances
3434
* returned from {@link #getGraphName()}, {@link #getSubject()},
3535
* {@link #getPredicate()}, {@link #getObject()} and {@link #asTriple()} will
3636
* have consistent {@link Object#equals(Object)} behavior.
3737
* <p>
38-
* Note that <code>Quad</code> methods are not required to return object
39-
* identical (<code>==</code>) instances as long as they are equivalent
38+
* Note that {@code Quad} methods are not required to return object
39+
* identical ({@code ==}) instances as long as they are equivalent
4040
* according to {@link Object#equals(Object)}. Specializations of
41-
* <code>Quad</code> may provide additional methods that are documented to be
41+
* {@code Quad} may provide additional methods that are documented to be
4242
* mutable.
4343
* <p>
44-
* <code>Quad</code> methods are <strong>thread-safe</strong>, however
44+
* {@code Quad} methods are <strong>thread-safe</strong>, however
4545
* specializations may provide additional methods that are documented to not be
4646
* thread-safe.
4747
* <p>
48-
* <code>Quad</code>s can be safely used in hashing collections like
48+
* {@code Quad}s can be safely used in hashing collections like
4949
* {@link java.util.HashSet} and {@link java.util.HashMap}.
5050
* <p>
51-
* Any <code>Quad</code> can be used interchangeably across Commons RDF
51+
* Any {@code Quad} can be used interchangeably across Commons RDF
5252
* implementations.
5353
*
5454
* @since 0.3.0-incubating
@@ -85,7 +85,7 @@ public interface Quad extends QuadLike<BlankNodeOrIRI> {
8585
* }
8686
* </pre>
8787
*
88-
* The <code>default</code> implementation of this method return a proxy
88+
* The {@code default} implementation of this method return a proxy
8989
* {@link Triple} instance that keeps a reference to this {@link Quad} to
9090
* call the underlying {@link TripleLike} methods, but supplies a
9191
* {@link Triple} compatible implementation of {@link Triple#equals(Object)}

‎commons-rdf-api/src/main/java/org/apache/commons/rdf/api/RDF.java

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
/**
2424
* A RDF implementation.
2525
* <p>
26-
* A <code>RDF</code> implementation can create instances of the {@link RDFTerm}
26+
* A {@code RDF} implementation can create instances of the {@link RDFTerm}
2727
* types {@link IRI}, {@link BlankNode} and {@link Literal}, as well as creating
2828
* instances of the types {@link Triple}, {@link Quad}, {@link Graph} or
2929
* {@link Dataset}.
@@ -32,7 +32,7 @@
3232
* and may throw {@link UnsupportedOperationException} where applicable, e.g. if
3333
* it does not support creating {@link Dataset}s or {@link Quad}s.
3434
* <p>
35-
* Instances of <code>RDF</code> work like a factory for creating Commons RDF
35+
* Instances of {@code RDF} work like a factory for creating Commons RDF
3636
* instances. spezializations of this interface may also provide methods for
3737
* conversions from/to their underlying RDF framework.
3838
* <p>
@@ -61,18 +61,18 @@ public interface RDF {
6161
/**
6262
* Create a blank node based on the given name.
6363
* <p>
64-
* All {@link BlankNode}s created with the given <code>name</code> <em>on a
65-
* particular instance</em> of <code>RDF</code> MUST be equivalent according
64+
* All {@link BlankNode}s created with the given {@code name} <em>on a
65+
* particular instance</em> of {@code RDF} MUST be equivalent according
6666
* to {@link BlankNode#equals(Object)},
6767
* <p>
68-
* The returned BlankNode MUST NOT be equal to <code>BlankNode</code>
69-
* instances returned for any other <code>name</code> or those returned from
68+
* The returned BlankNode MUST NOT be equal to {@code BlankNode}
69+
* instances returned for any other {@code name} or those returned from
7070
* {@link #createBlankNode()}.
7171
* <p>
7272
* The returned BlankNode SHOULD NOT be equivalent to any BlankNodes created
73-
* on a <em>different</em> <code>RDF</code> instance, e.g. different
74-
* instances of <code>RDF</code> should produce different blank nodes for
75-
* the same <code>name</code> unless they purposely are intending to create
73+
* on a <em>different</em> {@code RDF} instance, e.g. different
74+
* instances of {@code RDF} should produce different blank nodes for
75+
* the same {@code name} unless they purposely are intending to create
7676
* equivalent {@link BlankNode} instances (e.g. a reinstated
7777
* {@link Serializable} factory).
7878
*
@@ -129,7 +129,7 @@ public interface RDF {
129129
* equal to the provided lexical form, MUST NOT have a
130130
* {@link Literal#getLanguageTag()} present, and SHOULD return a
131131
* {@link Literal#getDatatype()} that is equal to the IRI
132-
* <code>http://www.w3.org/2001/XMLSchema#string</code>.
132+
* {@code http://www.w3.org/2001/XMLSchema#string}.
133133
*
134134
* @param lexicalForm
135135
* The literal value in plain text
@@ -164,7 +164,7 @@ public interface RDF {
164164
* The literal value
165165
* @param dataType
166166
* The data type IRI for the literal value, e.g.
167-
* <code>http://www.w3.org/2001/XMLSchema#integer</code>
167+
* {@code http://www.w3.org/2001/XMLSchema#integer}
168168
* @return The created Literal
169169
* @throws IllegalArgumentException
170170
* If any of the provided arguments are not acceptable, e.g.
@@ -180,7 +180,7 @@ public interface RDF {
180180
*
181181
* The provided language tag MUST be valid according to
182182
* <a href="https://tools.ietf.org/html/bcp47">BCP47</a>, e.g.
183-
* <code>en</code>.
183+
* {@code en}.
184184
*
185185
* The provided language tag
186186
* <a href="http://www.w3.org/TR/rdf11-concepts/#dfn-language-tagged-string"
@@ -189,7 +189,7 @@ public interface RDF {
189189
* The returned Literal SHOULD have a {@link Literal#getLexicalForm()} which
190190
* is equal to the provided lexicalForm, MUST return a
191191
* {@link Literal#getDatatype()} that is equal to the IRI
192-
* <code>http://www.w3.org/1999/02/22-rdf-syntax-ns#langString</code>, and
192+
* {@code http://www.w3.org/1999/02/22-rdf-syntax-ns#langString}, and
193193
* MUST have a {@link Literal#getLanguageTag()} present which SHOULD be
194194
* equal to the provided language tag (compared as
195195
* {@link String#toLowerCase(Locale)} using {@link Locale#ENGLISH}).

‎commons-rdf-api/src/main/java/org/apache/commons/rdf/api/RDFSyntax.java

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
* </p>
3434
* <p>
3535
* An enumeration of the official RDF 1.1 syntaxes is available in {@link W3CRDFSyntax} - for convenience they are also accessible as constants here, e.g.
36-
* <code>RDFSyntax.JSONLD</code>.
36+
* {@code RDFSyntax.JSONLD}.
3737
* </p>
3838
*/
3939
public interface RDFSyntax {
@@ -91,14 +91,14 @@ public interface RDFSyntax {
9191
/**
9292
* Return the RDFSyntax with the specified file extension.
9393
* <p>
94-
* The <code>fileExtension</code> is compared in lower case to all extensions supported, therefore it might not be equal to the
94+
* The {@code fileExtension} is compared in lower case to all extensions supported, therefore it might not be equal to the
9595
* {@link RDFSyntax#fileExtension} of the returned RDFSyntax.
9696
* </p>
9797
* <p>
9898
* This method support all syntaxes returned by {@link #w3cSyntaxes()}.
9999
* </p>
100100
*
101-
* @param fileExtension The fileExtension to match, starting with <code>.</code>
101+
* @param fileExtension The fileExtension to match, starting with {@code .}
102102
* @return If {@link Optional#isPresent()}, the {@link RDFSyntax} which has a matching {@link RDFSyntax#fileExtension()}, otherwise {@link Optional#empty()}
103103
* indicating that no matching file extension was found.
104104
*/
@@ -110,11 +110,11 @@ static Optional<RDFSyntax> byFileExtension(final String fileExtension) {
110110
/**
111111
* Return the RDFSyntax with the specified media type.
112112
* <p>
113-
* The <code>mediaType</code> is compared in lower case to all media types supported, therefore it might not be equal to the {@link RDFSyntax#mediaType} of
113+
* The {@code mediaType} is compared in lower case to all media types supported, therefore it might not be equal to the {@link RDFSyntax#mediaType} of
114114
* the returned RDFSyntax.
115115
* </p>
116116
* <p>
117-
* If the media type specifies parameters, e.g. <code>text/turtle; charset=ascii</code>, only the part of the string to before <code>;</code> is considered.
117+
* If the media type specifies parameters, e.g. {@code text/turtle; charset=ascii}, only the part of the string to before {@code ;} is considered.
118118
* </p>
119119
* <p>
120120
* This method support all syntaxes returned by {@link #w3cSyntaxes()}.
@@ -135,7 +135,7 @@ static Optional<RDFSyntax> byMediaType(final String mediaType) {
135135
* This method support all syntaxes returned by {@link #w3cSyntaxes()}.
136136
* </p>
137137
*
138-
* @param name The name to match, , e.g. <code>"JSONLD"</code>
138+
* @param name The name to match, , e.g. {@code "JSONLD"}
139139
* @return If {@link Optional#isPresent()}, the {@link RDFSyntax} which has a matching {@link RDFSyntax#name()}, otherwise {@link Optional#empty()}
140140
* indicating that no matching name was found.
141141
*/
@@ -177,7 +177,7 @@ static Set<RDFSyntax> w3cSyntaxes() {
177177
/**
178178
* The <a href="https://tools.ietf.org/html/rfc2046">IANA-registered</a> file extension.
179179
* <p>
180-
* The file extension includes the leading period, e.g. <code>.jsonld</code>
180+
* The file extension includes the leading period, e.g. {@code .jsonld}
181181
* </p>
182182
*
183183
* @return The registered file extension of the RDF Syntax
@@ -187,7 +187,7 @@ static Set<RDFSyntax> w3cSyntaxes() {
187187
/**
188188
* Sets of file extensions for this RDF syntax, including any non-official extensions.
189189
* <p>
190-
* The file extension includes the leading period, e.g. <code>.jsonld</code>
190+
* The file extension includes the leading period, e.g. {@code .jsonld}
191191
* </p>
192192
* <p>
193193
* The returned Set MUST include the value from {@link #fileExtension()}; this is the behavior of the default implementation.
@@ -214,14 +214,14 @@ default Set<String> fileExtensions() {
214214
* Note that the identifying IRI is generally distinct from the IRI of the document that <em>specifies</em> the RDF syntax.
215215
* </p>
216216
*
217-
* @return Identifying IRI, e.g. <code>http://www.w3.org/ns/formats/JSON-LD</code>
217+
* @return Identifying IRI, e.g. {@code http://www.w3.org/ns/formats/JSON-LD}
218218
*/
219219
IRI iri();
220220

221221
/**
222222
* The <a href="https://tools.ietf.org/html/rfc2046">IANA media type</a> for the RDF syntax.
223223
* <p>
224-
* The media type can be used as part of <code>Content-Type</code> and <code>Accept</code> for <em>content negotiation</em> in the
224+
* The media type can be used as part of {@code Content-Type} and {@code Accept} for <em>content negotiation</em> in the
225225
* <a href="https://tools.ietf.org/html/rfc7231#section-3.1.1.1">HTTP protocol</a>.
226226
* </p>
227227
*
@@ -232,7 +232,7 @@ default Set<String> fileExtensions() {
232232
/**
233233
* Sets of <a href="https://tools.ietf.org/html/rfc2046">IANA media types</a> that covers this RDF syntax, including any non-official media types.
234234
* <p>
235-
* The media type can be used as part of <code>Content-Type</code> and <code>Accept</code> for <em>content negotiation</em> in the
235+
* The media type can be used as part of {@code Content-Type} and {@code Accept} for <em>content negotiation</em> in the
236236
* <a href="https://tools.ietf.org/html/rfc7231#section-3.1.1.1">HTTP protocol</a>.
237237
* </p>
238238
* <p>
@@ -246,7 +246,7 @@ default Set<String> mediaTypes() {
246246
}
247247

248248
/**
249-
* A short name of the RDF Syntax e.g. <code>JSONLD</code>.
249+
* A short name of the RDF Syntax e.g. {@code JSONLD}.
250250
* <p>
251251
* The name is specific to Commons RDF and carries no particular meaning.
252252
* </p>

‎commons-rdf-api/src/main/java/org/apache/commons/rdf/api/RDFTerm.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,21 +30,21 @@
3030
* and {@link Literal#getLanguageTag()}) will have consistent
3131
* {@link #equals(Object)} behavior.
3232
* <p>
33-
* Note that methods in <code>RDFTerm</code> and its Commons RDF specializations
33+
* Note that methods in {@code RDFTerm} and its Commons RDF specializations
3434
* {@link IRI}, {@link BlankNode} and {@link Literal} are not required to return
35-
* object identical (<code>==</code>) instances as long as they are equivalent
35+
* object identical ({@code ==}) instances as long as they are equivalent
3636
* according to their {@link Object#equals(Object)}. Further specializations may
3737
* provide additional methods that are documented to be mutable.
3838
* <p>
39-
* Methods in <code>RDFTerm</code> and its Commons RDF specializations
39+
* Methods in {@code RDFTerm} and its Commons RDF specializations
4040
* {@link IRI}, {@link BlankNode} and {@link Literal} are
4141
* <strong>thread-safe</strong>, however further specializations may add
4242
* additional methods that are documented to not be thread-safe.
4343
* <p>
44-
* <code>RDFTerm</code>s can be safely used in hashing collections like
44+
* {@code RDFTerm}s can be safely used in hashing collections like
4545
* {@link java.util.HashSet} and {@link java.util.HashMap}.
4646
* <p>
47-
* Any <code>RDFTerm</code> can be used interchangeably across Commons RDF
47+
* Any {@code RDFTerm} can be used interchangeably across Commons RDF
4848
* implementations.
4949
*
5050
* @see <a href= "http://www.w3.org/TR/rdf11-concepts/#dfn-rdf-term">RDF-1.1

‎commons-rdf-api/src/main/java/org/apache/commons/rdf/api/Triple.java

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,27 +25,27 @@
2525
* <a href= "http://www.w3.org/TR/rdf11-concepts/#section-triples">RDF-1.1 Concepts and
2626
* Abstract Syntax</a>, a W3C Recommendation published on 25 February 2014.
2727
* <p>
28-
* A <code>Triple</code> object in Commons RDF is considered
28+
* A {@code Triple} object in Commons RDF is considered
2929
* <strong>immutable</strong>, that is, over its life time it will have
3030
* consistent behavior for its {@link #equals(Object)}, and the {@link RDFTerm}
3131
* instances returned from {@link #getSubject()}, {@link #getPredicate()} and
3232
* {@link #getObject()} will have consistent {@link RDFTerm#equals(Object)}
3333
* behavior.
3434
* <p>
35-
* Note that <code>Triple</code> methods are not required to return object
36-
* identical (<code>==</code>) instances as long as they are equivalent
35+
* Note that {@code Triple} methods are not required to return object
36+
* identical ({@code ==}) instances as long as they are equivalent
3737
* according to {@link RDFTerm#equals(Object)}. Specializations of
38-
* <code>Triple</code> may provide additional methods that are documented to be
38+
* {@code Triple} may provide additional methods that are documented to be
3939
* mutable.
4040
* <p>
41-
* <code>Triple</code> methods are <strong>thread-safe</strong>, however
41+
* {@code Triple} methods are <strong>thread-safe</strong>, however
4242
* specializations may provide additional methods that are documented to not be
4343
* thread-safe.
4444
* <p>
45-
* <code>Triple</code>s can be safely used in hashing collections like
45+
* {@code Triple}s can be safely used in hashing collections like
4646
* {@link java.util.HashSet} and {@link java.util.HashMap}.
4747
* <p>
48-
* Any <code>Triple</code> can be used interchangeably across Commons RDF
48+
* Any {@code Triple} can be used interchangeably across Commons RDF
4949
* implementations.
5050
*
5151
* @see Quad

0 commit comments

Comments
 (0)