Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
c42646f
Fix javadoc errors
dr0i Sep 27, 2021
001b560
Fix javadoc errors
dr0i Sep 30, 2021
86bfdb4
Add MissingJavadocMethod to checkstyle
dr0i Oct 1, 2021
d35fe04
Merge branch 'master' of https://github.com/metafacture/metafacture-c…
dr0i Oct 8, 2021
29352fc
Fix javadoc in the "commons" module
dr0i Oct 11, 2021
239a3de
Fix javadoc for module "elasticsearch"
dr0i Oct 11, 2021
0ca03f1
Fix javadoc for module "files"
dr0i Oct 11, 2021
ceae172
Fix javadoc for module "flowcontrol".
dr0i Oct 11, 2021
f7cc590
Fix javadoc for module "flux"
dr0i Oct 11, 2021
91f02e4
Fix javadoc for module "formeta"
dr0i Oct 11, 2021
24b3fe0
Fix javadoc for module "framework"
dr0i Oct 11, 2021
cabc095
Fix javadoc for module "html"
dr0i Oct 11, 2021
e3785d9
Fix javadoc for module "io" (#396)
dr0i Oct 18, 2021
527c24d
Fix javadoc for module "javaintegration" (#396)
dr0i Oct 18, 2021
273dea9
Fix javadoc for module "jdom" (#396)
dr0i Oct 18, 2021
16fa34d
Fix javadoc for module "json" (#396)
dr0i Oct 21, 2021
b5fb327
Fix javadoc for module "mangling" (#396)
dr0i Oct 21, 2021
118c86c
Fix javadoc for module "monitoring" (#396)
dr0i Oct 21, 2021
aa39675
Fix javadoc for module "runner" (#396)
dr0i Oct 21, 2021
ef337bc
Fix javadoc for module "statistics" (#396)
dr0i Oct 21, 2021
f53a156
Fix javadoc for module "strings" (#396)
dr0i Oct 21, 2021
e54ce38
Fix javadoc for module "triples" (#396)
dr0i Oct 21, 2021
a69bd87
Fix javadoc for module "xml" (#396)
dr0i Oct 21, 2021
4087c1a
Fix javadoc for module "metamorph" (#396)
dr0i Oct 22, 2021
78639a2
Fix javadoc for module "test" (#396)
dr0i Oct 22, 2021
6c9bf16
Fix javadoc error introduced with 86bfdb4c6a400d430e3de94f065564f5610…
dr0i Oct 22, 2021
640b646
Merge branch 'master' of https://github.com/metafacture/metafacture-c…
dr0i Oct 22, 2021
7b96367
Fix some more javadoc error and warnings (#396)
dr0i Oct 22, 2021
a3b5095
Javadoc fixes and improvements. (#396)
blackwinter Oct 23, 2021
ba79941
Fix Javadoc tag. (#396)
blackwinter Oct 23, 2021
39bd9e0
Fix Javadoc references. (#396)
blackwinter Oct 23, 2021
8b74457
Fix Javadoc value tags. (#396)
blackwinter Oct 23, 2021
f54e3fe
Validate Javadoc as part of the checks. (#396)
blackwinter Oct 26, 2021
87e602a
Remove listing of enum values (#396)
dr0i Oct 26, 2021
6f88f0c
Add NonEmptyAtclauseDescription (#396)
dr0i Oct 26, 2021
27599ca
Use @see in javadoc (#396)
dr0i Oct 26, 2021
0630ffa
Remove minLineCount from MissingJavadocMethod (#396)
dr0i Oct 26, 2021
e568830
Fix javadoc for module "biblio" (#396)
dr0i Oct 26, 2021
27ba247
Merge branch 'master' of https://github.com/metafacture/metafacture-c…
dr0i Oct 29, 2021
b3e9f38
Fix javadoc for MarcXmlEncoder (#396)
dr0i Oct 29, 2021
398599c
Fix all javadoc errors (#396)
dr0i Oct 30, 2021
3b8289e
Fix Javadoc references. (#396)
blackwinter Oct 30, 2021
6f07b3b
Use plural in enum description (#396)
dr0i Nov 2, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ subprojects {
apply plugin: 'checkstyle'

check.dependsOn(editorconfigCheck)
check.dependsOn(javadoc)

sourceCompatibility = 1.8
targetCompatibility = 1.8
Expand All @@ -81,6 +82,12 @@ subprojects {
group 'build'
}

javadoc {
options {
addBooleanOption 'Xwerror', true
}
}

artifacts {
archives sourceJar
archives javadocJar
Expand Down
3 changes: 3 additions & 0 deletions config/checkstyle/checkstyle.xml
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@
<module name="InterfaceIsType"/>
<module name="InterfaceTypeParameterName"/>
<module name="JavaNCSS"/>
<module name="JavadocMethod"/>
<module name="JavadocType"/>
<module name="LambdaParameterName"/>
<module name="LeftCurly"/>
Expand All @@ -81,6 +82,7 @@
<module name="MethodTypeParameterName"/>
<module name="MissingCtor"/>
<module name="MissingDeprecated"/>
<module name="MissingJavadocMethod"/>
<module name="MissingOverride"/>
<module name="MissingSwitchDefault"/>
<module name="ModifiedControlVariable"/>
Expand All @@ -97,6 +99,7 @@
<module name="NoClone"/>
<module name="NoEnumTrailingComma"/>
<module name="NoFinalizer"/>
<module name="NonEmptyAtclauseDescription"/>
<module name="NoWhitespaceAfter"/>
<module name="NoWhitespaceBefore"/>
<module name="OneStatementPerLine">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,9 @@ public final class AlephMabXmlHandler extends DefaultXmlPipe<StreamReceiver> {
private String currentTag = "";
private StringBuilder builder = new StringBuilder();

/**
* Creates instance of {@link AlephMabXmlHandler}.
*/
public AlephMabXmlHandler() {
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@ public final class AseqDecoder extends DefaultObjectPipe<String, StreamReceiver>
private static final int RECORD_IDENTIFIER_BEGIN = 0;
private static final int RECORD_IDENTIFIER_END = 9;

/**
* Creates an instance of {@link AseqDecoder}.
*/
public AseqDecoder() {
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,9 @@ public class ComarcXmlHandler extends DefaultXmlPipe<StreamReceiver> {
private String currentTag = "";
private StringBuilder builder = new StringBuilder();

/**
* Creates an instance of {@link ComarcXmlHandler}.
*/
public ComarcXmlHandler() {
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,9 @@ public final class MabDecoder extends DefaultObjectPipe<String, StreamReceiver>
private static final String ID_TAG = "001 ";
private static final int TAG_LENGTH = 4;

/**
* Creates an instance of {@link MabDecoder}.
*/
public MabDecoder() {
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,42 @@
*/
public interface FieldHandler {

/**
* Reference a field.
*
* @param tag the tag
* @param implDefinedPart the impl defined part
* @param value the value
*/
void referenceField(char[] tag, char[] implDefinedPart, String value);

/**
* Starts a data field.
*
* @param tag the tag
* @param implDefinedPart the impl defined part
* @param indicators the indicators
*/
void startDataField(char[] tag, char[] implDefinedPart, char[] indicators);

/**
* Ends the data field.
*/
void endDataField();

/**
* Sets the impl defined part.
*
* @param implDefinedPart he impl defined part
*/
void additionalImplDefinedPart(char[] implDefinedPart);

/**
* Sets the identifier to a value.
*
* @param identifier the identifier
* @param value the value
*/
void data(char[] identifier, String value);

}
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
package org.metafacture.biblio.iso2709;

/**
* Provides read access to the record label of a ISO 2709:2008 formatted
* Provides read access to the record label of an ISO 2709:2008 formatted
* record. The record label consists of the first 24 octets of the record.
* <p>
* Use {@link LabelBuilder} if write access to the label is required.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,22 +91,47 @@ private int findRecordIdFieldStart() {
return RECORD_ID_MISSING;
}

/**
* Gets the record format of the Label.
*
* @return the record format of the Label
*/
public RecordFormat getRecordFormat() {
return label.getRecordFormat();
}

/**
* Gets the record status of the Label.
*
* @return the record status of the Label
*/
public char getRecordStatus() {
return label.getRecordStatus();
}

/**
* Gets the impl codes.
*
* @return the impl codes
*/
public char[] getImplCodes() {
return label.getImplCodes();
}

/**
* Gets the systems chars of the Label.
*
* @return the system chars
*/
public char[] getSystemChars() {
return label.getSystemChars();
}

/**
* Gets the reserved char of the Label.
*
* @return the reserved char
*/
public char getReservedChar() {
return label.getReservedChar();
}
Expand Down
Loading