louisdevie/mustangproject
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

some javadoc updates

Browse Source
This commit is contained in:
jstaerk
2021-10-04 12:08:43 +02:00
parent df83c303a8
commit c4f3af75b9
2 changed files with 7 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
validator/src/main/java/org/mustangproject/validator/XMLValidator.java
View File

@@ -51,7 +51,7 @@ public class XMLValidator extends Validator {
/*** /***
* set source file * set source file
* @param name * @param name the absolute filename of an xml file to validate
* @throws IrrecoverableValidationError * @throws IrrecoverableValidationError
*/ */
public void setFilename(String name) throws IrrecoverableValidationError { // from XML Filename public void setFilename(String name) throws IrrecoverableValidationError { // from XML Filename
@@ -82,8 +82,8 @@ public class XMLValidator extends Validator {
/** /**
* whether uri1 has the same meaning like uri1 (it has, if it only differs in the fragment, i.e. uri1#1==uri1#2 ) * whether uri1 has the same meaning like uri1 (it has, if it only differs in the fragment, i.e. uri1#1==uri1#2 )
* @param uri1 * @param uri1 basis guideline ID
* @param uri2 * @param uri2 guideline ID to be checked
* @return true if semantically identical * @return true if semantically identical
*/ */
public static boolean matchesURI(String uri1, String uri2) { public static boolean matchesURI(String uri1, String uri2) {

7
validator/src/main/java/org/mustangproject/validator/ZUGFeRDValidator.java
View File

@@ -46,6 +46,7 @@ public class ZUGFeRDValidator {
* within the validation it turned out something in the options was wrong, e.g. * within the validation it turned out something in the options was wrong, e.g.
* the file did not exist. recommendation to show the help text again. Should be * the file did not exist. recommendation to show the help text again. Should be
* false if XML or PDF file was found * false if XML or PDF file was found
* @return false if any valid option was picked up
*/ */
public boolean hasOptionsError() { public boolean hasOptionsError() {
return !optionsRecognized; return !optionsRecognized;
@@ -59,7 +60,7 @@ public class ZUGFeRDValidator {
/*** /***
* in case the result was not valid the error code of the app will be set to -1 * in case the result was not valid the error code of the app will be set to -1
* *
* @return * @return true if both xml and pdf were valid (contained no errors, notices are ignored)
*/ */
public boolean wasCompletelyValid() { public boolean wasCompletelyValid() {
return wasCompletelyValid; return wasCompletelyValid;
@@ -69,8 +70,8 @@ public class ZUGFeRDValidator {
/*** /***
* performs a validation on the file filename * performs a validation on the file filename
* *
* @param filename * @param filename the complete absolute filename of a PDF or XML
* @return * @return a xml string with the validation result
*/ */
public String validate(String filename) { public String validate(String filename) {
boolean xmlValidity; boolean xmlValidity;