fixed javadocs

This commit is contained in:
Brian Long 2022-10-10 22:25:47 -04:00
parent cc1019a22e
commit 86d4d76e54
3 changed files with 12 additions and 6 deletions

View File

@ -46,9 +46,10 @@ public abstract class DisablableGoal extends AbstractMojo {
* Identical to the `AbstractMojo.execute()` method, but it is only called
* when this is enabled.
*
* @see AbstractMojo#execute()
*
* @throws MojoExecutionException The goal failed to execute.
* @throws MojoFailureException The goal failed whiling executing.
* @see org.apache.maven.plugin.AbstractMojo.execute()
*/
public abstract void executeEnabled() throws MojoExecutionException, MojoFailureException;

View File

@ -47,11 +47,12 @@ public class ListMapSorter {
* comparison. If it doesn't have a value, then it will sort to the end of
* the array.
*
* @see MapComparator
*
* @param <V> The type of value in the maps.
* @param listOfMaps A list of maps.
* @param mapKey A key in the maps.
* @return true if any maps were moved/sorted; false if unchanged.
* @see com.inteligr8.maven.aps.modeling.util.MapComparator
*/
public <V> boolean sort(List<Map<String, V>> listOfMaps, String mapKey) {
return this.sort(listOfMaps, new MapComparator<String, V>(mapKey));

View File

@ -197,6 +197,7 @@ public class ModelUtil {
/**
* This method reads/parses JSON from the specified file.
*
* @param <T> The class of the type to parse.
* @param file A file handle to an existing valid JSON file.
* @param type A type parse the JSON into (using the Jackson parser).
* @return An instance of the specified type.
@ -215,6 +216,7 @@ public class ModelUtil {
/**
* This method reads/parses JSON from the specified file.
*
* @param <T> The class of the type to parse.
* @param file A file handle to an existing valid JSON file.
* @return A JSON array as a list.
* @throws IOException A file I/O issue occurred.
@ -260,6 +262,7 @@ public class ModelUtil {
/**
* This method reads/parses JSON from the specified stream.
*
* @param <T> The class of the type to parse.
* @param istream An input stream to valid JSON.
* @param type A type parse the JSON into (using the Jackson parser).
* @return An instance of the specified type.
@ -272,6 +275,7 @@ public class ModelUtil {
/**
* This method reads/parses JSON from the specified stream.
*
* @param <T> The class of the type to parse.
* @param istream An input stream to valid JSON.
* @return A JSON array as a list.
* @throws IOException A stream I/O issue occurred.
@ -450,10 +454,10 @@ public class ModelUtil {
*
* This method will load the full DOM of XML into memory.
*
* @param sourceFile A file handle to an existing valid XML file.
* @param targetFile A file handle.
* @throws IOException A file I/O issue occurred.
* @throws SAXException The file is not valid XML.
* @param istream An input stream to valid XML.
* @param ostream An output stream.
* @throws IOException A stream I/O issue occurred.
* @throws SAXException The stream is not valid XML.
* @throws TransformerException An unknown XML transformation issue occurred.
*/
public void xml(InputStream istream, OutputStream ostream) throws IOException, SAXException, TransformerException {