Skip to content

Commit

Permalink
Added doclint param to javadoc. Fixed javadocs.
Browse files Browse the repository at this point in the history
  • Loading branch information
sebhofmann committed Oct 7, 2022
1 parent bdb230f commit 0c00a44
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 17 deletions.
6 changes: 6 additions & 0 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,12 @@
</execution>
</executions>
</plugin>
<plugin>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<doclint>all,-missing</doclint>
</configuration>
</plugin>
</plugins>
</pluginManagement>
</build>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
* contributors of all bibliography entries currently in the basket.
* The xml returned is taken in edit-contributors.xml to
* edit the names and PID assignment of contributors in the basket.
* It maps URIs of scheme nameLister:<anyDummyValue>.
* It maps URIs of scheme nameLister:&lt;anyDummyValue&gt;.
*
* @author Frank L\u00FCtzenkirchen
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -134,18 +134,18 @@ public Element getPersonDetails(Map<String, String> paramMap) {
/**
*
* Format of returned XML:
* <results>
* <person>
* <attribute1>some_value1</attribute1>
* <attribute2>some_value2</attribute2>
* <identity>some configurable identity string (email, affiliation etc.)</identity>
* </person>
* <person>
* <attribute1>other_value1</attribute1>
* <attribute2>other_value2</attribute2>
* <identity>some configurable identity string (email, affiliation etc.)</identity>
* </person>
* </results>
* &lt;results&gt;
* &lt;person&gt;
* &lt;attribute1&gt;some_value1&lt;/attribute1&gt;
* &lt;attribute2&gt;some_value2&lt;/attribute2&gt;
* &lt;identity&gt;some configurable identity string (email, affiliation etc.)&lt;/identity&gt;
* &lt;/person&gt;
* &lt;person&gt;
* &lt;attribute1&gt;other_value1&lt;/attribute1&gt;
* &lt;attribute2&gt;other_value2&lt;/attribute2&gt;
* &lt;identity&gt;some configurable identity string (email, affiliation etc.)&lt;/identity&gt;
* &lt;/person&gt;
* &lt;/results&gt;
*/
@Override
public Element searchPerson(Map<String, String> paramMap) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
*
* lsf:pid=4711
* returns the metadata of person 4711
* lsf:lastName=Meier&firstName=E
* lsf:lastName=Meier&amp;firstName=E
* returns a list of matching person entries
*
* To use this resolver add property:
Expand Down
3 changes: 1 addition & 2 deletions ubo-common/src/main/java/org/mycore/ubo/lsf/LSFService.java
Original file line number Diff line number Diff line change
Expand Up @@ -133,8 +133,7 @@ public Element getPersonDetails(Map<String, String> attributes) {
* Returns an XML element containing a list of all person data found in HIS LSF for the given name.
* The method searches in the field personal.nachname.
*
* @param attributes The last name (or part of it) of the person to search for.
* @param attributes The first name of the person to search for.
* @param attributes The last name (or part of it) of the person to search for. The first name of the person to search for.
*/
public Element searchPerson(Map<String, String> attributes) {
Element results = new Element("results");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
*
* 4. Persist all new MCRUsers ONLY if they where matched/enriched in 2.1. or in 3.
*
* 5. Extend the mods:name -> mods:nameIdentifier element of the publication with the configured "lead-ID" if it is
* 5. Extend the mods:name -&gt; mods:nameIdentifier element of the publication with the configured "lead-ID" if it is
* not present but available in the matched MCRUsers attributes.
*
* 6. If no MCRUser was created because there was neither Match found nor attributes enriched (2.1. or 3.), check each
Expand Down

0 comments on commit 0c00a44

Please sign in to comment.