Skip to content

Commit 9ada3e0

Browse files
adamretteradamretter
committed
[bugfix] Fix Javadoc errors and warnings
1 parent d37f67a commit 9ada3e0

13 files changed

Lines changed: 223 additions & 23 deletions

File tree

‎exist-core/pom.xml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -806,6 +806,7 @@
806806
<include>src/main/java/org/exist/protocolhandler/xmlrpc/XmlrpcUpload.java</include>
807807
<include>src/main/java/org/exist/repo/ClasspathHelper.java</include>
808808
<include>src/main/java/org/exist/repo/Deployment.java</include>
809+
<include>src/main/java/org/exist/repo/ExistRepository.java</include>
809810
<include>src/main/java/org/exist/scheduler/impl/QuartzSchedulerImpl.java</include>
810811
<include>src/main/java/org/exist/security/EffectiveSubject.java</include>
811812
<include>src/main/java/org/exist/security/SecurityManager.java</include>
@@ -1025,6 +1026,7 @@
10251026
<exclude>src/main/java/org/exist/protocolhandler/xmlrpc/XmlrpcUpload.java</exclude>
10261027
<exclude>src/main/java/org/exist/repo/ClasspathHelper.java</exclude>
10271028
<exclude>src/main/java/org/exist/repo/Deployment.java</exclude>
1029+
<exclude>src/main/java/org/exist/repo/ExistRepository.java</exclude>
10281030
<exclude>src/main/java/org/exist/scheduler/impl/QuartzSchedulerImpl.java</exclude>
10291031
<exclude>src/main/java/org/exist/security/EffectiveSubject.java</exclude>
10301032
<exclude>src/main/java/org/exist/security/SecurityManager.java</exclude>

‎exist-core/src/main/java/org/exist/dom/persistent/DocumentImpl.java‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -482,6 +482,10 @@ public void setLockToken(final LockToken token) {
482482
}
483483

484484
/**
485+
* Get the Document Type.
486+
*
487+
* @return the document type.
488+
*
485489
* @deprecated use {@link #getDoctype()}.
486490
*/
487491
@Deprecated

‎exist-core/src/main/java/org/exist/repo/ExistRepository.java‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,28 @@
11
/*
2+
* Elemental
3+
* Copyright (C) 2024, Evolved Binary Ltd
4+
*
5+
* admin@evolvedbinary.com
6+
* https://www.evolvedbinary.com | https://www.elemental.xyz
7+
*
8+
* This library is free software; you can redistribute it and/or
9+
* modify it under the terms of the GNU Lesser General Public
10+
* License as published by the Free Software Foundation; version 2.1.
11+
*
12+
* This library is distributed in the hope that it will be useful,
13+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
14+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15+
* Lesser General Public License for more details.
16+
*
17+
* You should have received a copy of the GNU Lesser General Public
18+
* License along with this library; if not, write to the Free Software
19+
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20+
*
21+
* NOTE: Parts of this file contain code from 'The eXist-db Authors'.
22+
* The original license header is included below.
23+
*
24+
* =====================================================================
25+
*
226
* eXist-db Open Source Native XML Database
327
* Copyright (C) 2001 The eXist-db Authors
428
*
@@ -287,6 +311,8 @@ public Path resolveXQueryModule(final String namespace) throws XPathException {
287311
* @param xqueryPath the path to the xquery within the EXPath filesystem repo.
288312
*
289313
* @return the database source for the xquery, or null.
314+
*
315+
* @throws PermissionDeniedException if the caller is not authorized.
290316
*/
291317
public @Nullable org.exist.source.Source resolveStoredXQueryModuleFromDb(final DBBroker broker, final Path xqueryPath) throws PermissionDeniedException {
292318
if (!xqueryPath.startsWith(expathDir)) {

‎extensions/contentextraction/pom.xml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,7 @@
175175
<include>pom.xml</include>
176176
<include>src/test/resources-filtered/conf.xml</include>
177177
<include>src/test/resources/log4j2.xml</include>
178+
<include>src/main/java/org/exist/contentextraction/ContentReceiver.java</include>
178179
</includes>
179180
</licenseSet>
180181

@@ -187,6 +188,7 @@
187188
<exclude>pom.xml</exclude>
188189
<exclude>src/test/resources-filtered/conf.xml</exclude>
189190
<exclude>src/test/resources/log4j2.xml</exclude>
191+
<exclude>src/main/java/org/exist/contentextraction/ContentReceiver.java</exclude>
190192
<exclude>src/test/java/org/exist/contentextraction/xquery/Util.java</exclude>
191193
</excludes>
192194
</licenseSet>

‎extensions/contentextraction/src/main/java/org/exist/contentextraction/ContentReceiver.java‎

Lines changed: 31 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,28 @@
11
/*
2+
* Elemental
3+
* Copyright (C) 2024, Evolved Binary Ltd
4+
*
5+
* admin@evolvedbinary.com
6+
* https://www.evolvedbinary.com | https://www.elemental.xyz
7+
*
8+
* This library is free software; you can redistribute it and/or
9+
* modify it under the terms of the GNU Lesser General Public
10+
* License as published by the Free Software Foundation; version 2.1.
11+
*
12+
* This library is distributed in the hope that it will be useful,
13+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
14+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15+
* Lesser General Public License for more details.
16+
*
17+
* You should have received a copy of the GNU Lesser General Public
18+
* License along with this library; if not, write to the Free Software
19+
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20+
*
21+
* NOTE: Parts of this file contain code from 'The eXist-db Authors'.
22+
* The original license header is included below.
23+
*
24+
* =====================================================================
25+
*
226
* eXist-db Open Source Native XML Database
327
* Copyright (C) 2001 The eXist-db Authors
428
*
@@ -64,12 +88,13 @@ public class ContentReceiver implements Receiver {
6488
private boolean sendDataToCB = false;
6589

6690
/**
67-
* Receiver constructor
68-
*
69-
* @param context The XQuery context
70-
* @param paths Paths that must be extracted from the TIKA XHTML document
71-
* @param ref Reference to callback function
72-
* @param userData Additional user supplied datas
91+
* Receiver constructor
92+
*
93+
* @param expression the calling expression.
94+
* @param context The XQuery context.
95+
* @param paths Paths that must be extracted from the TIKA XHTML document.
96+
* @param ref Reference to callback function.
97+
* @param userData Additional user supplied data.
7398
*/
7499
public ContentReceiver(final Expression expression, XQueryContext context, NodePath[] paths, FunctionReference ref, Sequence userData) {
75100
this.expression = expression;

‎extensions/modules/compression/pom.xml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,7 @@
162162
<include>pom.xml</include>
163163
<include>src/test/resources-filtered/conf.xml</include>
164164
<include>src/test/resources/log4j2.xml</include>
165+
<include>src/main/java/org/exist/xquery/modules/compression/EntryFunctions.java</include>
165166
</includes>
166167
</licenseSet>
167168

@@ -174,6 +175,7 @@
174175
<exclude>pom.xml</exclude>
175176
<exclude>src/test/resources-filtered/conf.xml</exclude>
176177
<exclude>src/test/resources/log4j2.xml</exclude>
178+
<exclude>src/main/java/org/exist/xquery/modules/compression/EntryFunctions.java</exclude>
177179
</excludes>
178180
</licenseSet>
179181

‎extensions/modules/compression/src/main/java/org/exist/xquery/modules/compression/EntryFunctions.java‎

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,28 @@
11
/*
2+
* Elemental
3+
* Copyright (C) 2024, Evolved Binary Ltd
4+
*
5+
* admin@evolvedbinary.com
6+
* https://www.evolvedbinary.com | https://www.elemental.xyz
7+
*
8+
* This library is free software; you can redistribute it and/or
9+
* modify it under the terms of the GNU Lesser General Public
10+
* License as published by the Free Software Foundation; version 2.1.
11+
*
12+
* This library is distributed in the hope that it will be useful,
13+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
14+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15+
* Lesser General Public License for more details.
16+
*
17+
* You should have received a copy of the GNU Lesser General Public
18+
* License along with this library; if not, write to the Free Software
19+
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20+
*
21+
* NOTE: Parts of this file contain code from 'The eXist-db Authors'.
22+
* The original license header is included below.
23+
*
24+
* =====================================================================
25+
*
226
* eXist-db Open Source Native XML Database
327
* Copyright (C) 2001 The eXist-db Authors
428
*
@@ -358,11 +382,14 @@ private enum DataType {
358382
}
359383

360384
/**
361-
* Convert path (URL, file path) to a File object.
385+
* Get a file path.
386+
*
387+
* @param path Path written as OS specific path or as URL.
388+
* @param expression the calling expression.
389+
*
390+
* @return a path to the file.
362391
*
363-
* @param path Path written as OS specific path or as URL
364-
* @return File object
365-
* @throws XPathException Thrown when the URL cannot be used.
392+
* @throws XPathException if the path is an invalid URI.
366393
*/
367394
public static Path getFile(final String path, final Expression expression) throws XPathException {
368395
if(path.startsWith("file:")){

‎extensions/modules/file/pom.xml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,8 @@
211211
<include>src/test/resources-filtered/conf.xml</include>
212212
<include>src/test/resources/log4j2.xml</include>
213213
<include>src/test/resources/standalone-webapp/WEB-INF/web.xml</include>
214+
<include>src/main/java/org/exist/xquery/modules/file/FileModuleHelper.java</include>
215+
<include>src/main/java/org/exist/xquery/modules/file/Sync.java</include>
214216
</includes>
215217
</licenseSet>
216218

@@ -224,6 +226,8 @@
224226
<exclude>src/test/resources-filtered/conf.xml</exclude>
225227
<exclude>src/test/resources/log4j2.xml</exclude>
226228
<exclude>src/test/resources/standalone-webapp/WEB-INF/web.xml</exclude>
229+
<exclude>src/main/java/org/exist/xquery/modules/file/FileModuleHelper.java</exclude>
230+
<exclude>src/main/java/org/exist/xquery/modules/file/Sync.java</exclude>
227231
</excludes>
228232
</licenseSet>
229233

‎extensions/modules/file/src/main/java/org/exist/xquery/modules/file/FileModuleHelper.java‎

Lines changed: 32 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,28 @@
11
/*
2+
* Elemental
3+
* Copyright (C) 2024, Evolved Binary Ltd
4+
*
5+
* admin@evolvedbinary.com
6+
* https://www.evolvedbinary.com | https://www.elemental.xyz
7+
*
8+
* This library is free software; you can redistribute it and/or
9+
* modify it under the terms of the GNU Lesser General Public
10+
* License as published by the Free Software Foundation; version 2.1.
11+
*
12+
* This library is distributed in the hope that it will be useful,
13+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
14+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15+
* Lesser General Public License for more details.
16+
*
17+
* You should have received a copy of the GNU Lesser General Public
18+
* License along with this library; if not, write to the Free Software
19+
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20+
*
21+
* NOTE: Parts of this file contain code from 'The eXist-db Authors'.
22+
* The original license header is included below.
23+
*
24+
* =====================================================================
25+
*
226
* eXist-db Open Source Native XML Database
327
* Copyright (C) 2001 The eXist-db Authors
428
*
@@ -33,20 +57,21 @@
3357
*
3458
* @author <a href="mailto:dannes@exist-db.org">Dannes Wessels</a>
3559
*/
36-
37-
3860
public class FileModuleHelper {
3961

4062
private FileModuleHelper() {
4163
// no instance
4264
}
4365

4466
/**
45-
* Convert path (URL, file path) to a File object.
46-
*
47-
* @param path Path written as OS specific path or as URL
48-
* @return File object
49-
* @throws XPathException Thrown when the URL cannot be used.
67+
* Get a file path.
68+
*
69+
* @param path Path written as OS specific path or as URL.
70+
* @param expression the calling expression.
71+
*
72+
* @return a path to the file.
73+
*
74+
* @throws XPathException if the path is an invalid URI.
5075
*/
5176
public static Path getFile(String path, final Expression expression) throws XPathException {
5277
if(path.startsWith("file:")){

‎extensions/modules/file/src/main/java/org/exist/xquery/modules/file/Sync.java‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,28 @@
11
/*
2+
* Elemental
3+
* Copyright (C) 2024, Evolved Binary Ltd
4+
*
5+
* admin@evolvedbinary.com
6+
* https://www.evolvedbinary.com | https://www.elemental.xyz
7+
*
8+
* This library is free software; you can redistribute it and/or
9+
* modify it under the terms of the GNU Lesser General Public
10+
* License as published by the Free Software Foundation; version 2.1.
11+
*
12+
* This library is distributed in the hope that it will be useful,
13+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
14+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15+
* Lesser General Public License for more details.
16+
*
17+
* You should have received a copy of the GNU Lesser General Public
18+
* License along with this library; if not, write to the Free Software
19+
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20+
*
21+
* NOTE: Parts of this file contain code from 'The eXist-db Authors'.
22+
* The original license header is included below.
23+
*
24+
* =====================================================================
25+
*
226
* eXist-db Open Source Native XML Database
327
* Copyright (C) 2001 The eXist-db Authors
428
*
@@ -515,6 +539,11 @@ private static boolean isExcludedPath(final String rootTargetAbsPath, final Path
515539

516540
/**
517541
* Check if any of the patterns matches the path.
542+
*
543+
* @param patterns the patterns to match in the path.
544+
* @param path the path to search.
545+
*
546+
* @return true if any of the patterns match, false otherwise.
518547
*/
519548
public static boolean matchAny(final Iterable<String> patterns, final String path) {
520549
for (final String pattern : patterns) {

0 commit comments

Comments
 (0)