Skip to content

Commit 4030b98

Browse files
committed
Fix javadoc
1 parent e65859f commit 4030b98

File tree

7 files changed

+9
-13
lines changed

7 files changed

+9
-13
lines changed

exist-core/src/main/java/org/exist/storage/BrokerPool.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1917,7 +1917,7 @@ public PluginsManager getPluginsManager() {
19171917

19181918
/**
19191919
* Represents a change involving {@link BrokerPool#inactiveBrokers}
1920-
* or {@link BrokerPool#activeBrokers} or {@link DBBroker#referenceCount}
1920+
* or {@link BrokerPool#activeBrokers} or {@link DBBroker#getReferenceCount}
19211921
*
19221922
* Used for tracing broker leases
19231923
*/

exist-core/src/main/java/org/exist/storage/DBBroker.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1100,7 +1100,7 @@ public abstract IEmbeddedXMLStreamReader newXMLStreamReader(NodeHandle node, boo
11001100
/**
11011101
* Reads and populates the metadata for a sub-Collection
11021102
*
1103-
* The entry to read is determined by {@link SubCollectionEntry#uri}
1103+
* The entry to read is determined by {@link SubCollectionEntry#getUri()}
11041104
*
11051105
* NOTE: It is assumed that the caller holds a {@link LockMode#READ_LOCK} (or better)
11061106
* on the Collection indicated in `entry`.

exist-core/src/main/java/org/exist/storage/io/BlockingInputStream.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ private int availablePart2() {
203203
*
204204
*
205205
* @param b the <code>byte</code>.
206-
* @throws ExistIOException if an I/O error occurs. In particular,
206+
* @throws IOException if an I/O error occurs. In particular,
207207
* an <code>ExistIOException</code> may be thrown if the
208208
* output stream has been closed.
209209
*/

exist-core/src/main/java/org/exist/util/CharSlice.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ public int hashCode() {
129129

130130
/**
131131
* Get the index of a specific character in the sequence. Returns -1 if not found.
132-
* This method mimics {@link String#indexOf}
132+
* This method mimics {@link String#indexOf(String)}
133133
* @param c the character to be found
134134
* @return the position of the first occurrence of that character, or -1 if not found.
135135
*/

exist-core/src/main/java/org/exist/xmldb/RemoteXMLResource.java

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -117,8 +117,7 @@ public RemoteXMLResource(final RemoteCollection parent, final XmldbURI docId, fi
117117
* @param type the type of the remote resource
118118
*
119119
* @throws XMLDBException if an error occurs during construction
120-
*
121-
* @deprecated Use {@link #RemoteXMLResource(Leasable.Lease, RemoteCollection, int, int, XmldbURI, Optional, Optional)}.
120+
* @deprecated Use {@link #RemoteXMLResource(RemoteCollection, int, int, XmldbURI, Optional, Optional)}.
122121
*/
123122
public RemoteXMLResource(final RemoteCollection parent, final XmldbURI docId, final Optional<String> id, final Optional<String> type)
124123
throws XMLDBException {
@@ -128,7 +127,6 @@ public RemoteXMLResource(final RemoteCollection parent, final XmldbURI docId, fi
128127
/**
129128
* Construct a remote XML Resource.
130129
*
131-
* @param xmlRpcClientLease the XML-RPC Client lease
132130
* @param parent the parent collection
133131
* @param handle the handle to the remote resource
134132
* @param pos the position of the remote resource

exist-core/src/main/java/org/exist/xmldb/RemoteXPathQueryService.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,6 @@ public class RemoteXPathQueryService extends AbstractRemote implements EXistXPat
5555
* Creates a new RemoteXPathQueryService instance.
5656
*
5757
* @param leasableXmlRpcClient the XML-RPC client lease
58-
* @param xmlRpcClient the XML-RPC client
5958
* @param collection a RemoteCollection value
6059
*/
6160
public RemoteXPathQueryService(final Leasable<XmlRpcClient> leasableXmlRpcClient, final RemoteCollection collection) {

exist-core/src/main/java/org/exist/xquery/functions/fn/FunSubstring.java

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,7 @@ private boolean validEndPosition(NumericValue end, NumericValue start)
231231
*
232232
* @see <a href="http://www.w3.org/TR/xpath-functions/#func-substring">w3.org</a>
233233
*
234-
* @param stringSource The source string to substring
234+
* @param sourceString The source string to substring
235235
* @param startingLoc The Starting Location for the substring, start
236236
* index is 1
237237
*
@@ -253,10 +253,9 @@ private StringValue substring(String sourceString, NumericValue startingLoc)
253253
*
254254
* @see <a href="http://www.w3.org/TR/xpath-functions/#func-substring">http://www.w3.org/TR/xpath-functions/#func-substring</a>
255255
*
256-
* @param stringSource The source string to substring
257-
* @param startingLoc The Starting Location for the substring, start
258-
* index is 1
259-
* @param length The length of the substring
256+
* @param sourceString The source string to substring
257+
* @param startingLoc The Starting Location for the substring, start index is 1
258+
* @param endingLoc The Ending Location for the substring
260259
*
261260
* @return The StringValue of the substring
262261
*/

0 commit comments

Comments
 (0)