16-FixJavadocIssues

This commit is contained in:
Adrian-Devries 2025-04-24 12:54:04 +02:00
parent d622da7979
commit 70a98f08fe
7 changed files with 7 additions and 8 deletions

View file

@ -183,7 +183,7 @@ public class InputFactory {
/** /**
* Reads a test document from a {@link Source} using a specified digest algorithm. * Reads a test document from a {@link Source} using a specified digest algorithm.
* * <p>
* Note: computing the hashcode is only supported for {@link StreamSource}. You can not directly use other * Note: computing the hashcode is only supported for {@link StreamSource}. You can not directly use other
* {@link Source Soures}. You need to supply the hashcode for identification then. * {@link Source Soures}. You need to supply the hashcode for identification then.
* *

View file

@ -27,9 +27,9 @@ import java.net.URI;
/** /**
* Centralized construction and configuration of XML related infrastructure components. This interface allows to use * Centralized construction and configuration of XML related infrastructure components. This interface allows to use
* custom implementations and configurations of internal xml related factories and objects. * custom implementations and configurations of internal xml related factories and objects.
* * <p>
* The KoSIT Validator provides out of the box implementations with various security levels based on openjdk SAX stack. * The KoSIT Validator provides out of the box implementations with various security levels based on openjdk SAX stack.
* * <p>
* If you decide to implement a custom strategy, please be aware of XML security within your stack. The validator * If you decide to implement a custom strategy, please be aware of XML security within your stack. The validator
* components beyond this strategy asume secured implementation of the interfaces provided by this strategy. There is no * components beyond this strategy asume secured implementation of the interfaces provided by this strategy. There is no
* effort to mitigate or prevent xml related security issues such as XXE, loading external sources etc. Your would be * effort to mitigate or prevent xml related security issues such as XXE, loading external sources etc. Your would be

View file

@ -30,7 +30,7 @@ import static org.apache.commons.lang3.StringUtils.isNotEmpty;
/** /**
* Commandline interface of the validator. It parses the commandline args and hands over actual execution to * Commandline interface of the validator. It parses the commandline args and hands over actual execution to
* {@link Validator}. * {@link Validator}.
* * <p>
* This separated from {@link Validator} to configure the slf4j simple logging. * This separated from {@link Validator} to configure the slf4j simple logging.
* *
* @author Andreas Penski * @author Andreas Penski

View file

@ -30,7 +30,7 @@ import java.net.URL;
/** /**
* An {@link Input} carries an {@link URL} which can be used for all 'locatable' inputs such as {@link File}, * An {@link Input} carries an {@link URL} which can be used for all 'locatable' inputs such as {@link File},
* {@link java.nio.file.Path} and any other {@link URL}. * {@link java.nio.file.Path} and any other {@link URL}.
* * <p>
* This stream is NOT read into memory. So this implementation has good in memory efficieny. The validation process MAY * This stream is NOT read into memory. So this implementation has good in memory efficieny. The validation process MAY
* read the stream more than once. Make sure, that the {@link URL} points to fast I/O devices * read the stream more than once. Make sure, that the {@link URL} points to fast I/O devices
* *

View file

@ -35,7 +35,7 @@ import static org.apache.commons.lang3.StringUtils.defaultIfBlank;
* <p> * <p>
* Note: The various implementations of {@link Source} varies wether the can be read twice or no. This implementation * Note: The various implementations of {@link Source} varies wether the can be read twice or no. This implementation
* tries to handle this with respect document identification (hashcode). * tries to handle this with respect document identification (hashcode).
* * <p>
* This class is known to work with: * This class is known to work with:
* <ul> * <ul>
* <li>{@link StreamSource} - both {@link java.io.InputStream} based and {@link java.io.Reader} based</li> * <li>{@link StreamSource} - both {@link java.io.InputStream} based and {@link java.io.Reader} based</li>

View file

@ -52,7 +52,6 @@ public class Result<T, E> {
/** /**
* Erzeugt ein neues Ergebnis mit einem Ergebnisobjekt * Erzeugt ein neues Ergebnis mit einem Ergebnisobjekt
* *
* @param o
*/ */
public Result(T o) { public Result(T o) {
this(o, Collections.emptyList()); this(o, Collections.emptyList());

View file

@ -52,7 +52,7 @@ import java.nio.file.Path;
* functionality and therefore needs a {@link Source} to do the actual validation. Since we base the validator on Saxon * functionality and therefore needs a {@link Source} to do the actual validation. Since we base the validator on Saxon
* HE functionality, we have no support for schema in Saxon (e.g. the in memory version of the document is not * HE functionality, we have no support for schema in Saxon (e.g. the in memory version of the document is not
* schema-aware) and need to re-read the actual source. * schema-aware) and need to re-read the actual source.
* * <p>
* Since the actual {@link Input} implementation may not be read twice, we must serialize the previously read document. * Since the actual {@link Input} implementation may not be read twice, we must serialize the previously read document.
* This implementation tries to do the validation in an efficient manner. If possible the source is read a second time * This implementation tries to do the validation in an efficient manner. If possible the source is read a second time
* to validate. If not, the source is serialized to the heap upon re-read/validaiton up to a configurable file size. The * to validate. If not, the source is serialized to the heap upon re-read/validaiton up to a configurable file size. The