search

cs-au-dk / dk.brics.automaton

dk.brics.automaton - finite-state automata and regular expressions for Java
http://www.brics.dk/automaton/
Other
211 stars 77 forks source link

Fix Javadoc WARNING's post JDK11 upgrade #30

Open lewismc opened 3 years ago

lewismc commented 3 years ago

The following JDK WARNING's should be addressed

100 warnings
[WARNING] Javadoc Warnings
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:505: warning: no @return
[WARNING] public int getNumberOfStates() {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:515: warning: no @return
[WARNING] public int getNumberOfTransitions() {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:595: warning: no @return
[WARNING] public String toDot() {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:682: warning: no @return
[WARNING] public static Automaton load(URL url) throws IOException, ClassCastException, ClassNotFoundException {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:693: warning: no @return
[WARNING] public static Automaton load(InputStream stream) throws IOException, ClassCastException, ClassNotFoundException {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:712: warning: no @return
[WARNING] public static Automaton makeEmpty()   {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:719: warning: no @return
[WARNING] public static Automaton makeEmptyString() {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:726: warning: no @return
[WARNING] public static Automaton makeAnyString()   {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:733: warning: no @return
[WARNING] public static Automaton makeAnyChar() {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:740: warning: no @param for c
[WARNING] public static Automaton makeChar(char c) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:740: warning: no @return
[WARNING] public static Automaton makeChar(char c) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:747: warning: no @param for min
[WARNING] public static Automaton makeCharRange(char min, char max) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:747: warning: no @param for max
[WARNING] public static Automaton makeCharRange(char min, char max) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:747: warning: no @return
[WARNING] public static Automaton makeCharRange(char min, char max) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:754: warning: no @param for set
[WARNING] public static Automaton makeCharSet(String set) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:754: warning: no @return
[WARNING] public static Automaton makeCharSet(String set) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:761: warning: no @param for min
[WARNING] public static Automaton makeInterval(int min, int max, int digits) throws IllegalArgumentException {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:761: warning: no @param for max
[WARNING] public static Automaton makeInterval(int min, int max, int digits) throws IllegalArgumentException {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:761: warning: no @param for digits
[WARNING] public static Automaton makeInterval(int min, int max, int digits) throws IllegalArgumentException {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:761: warning: no @return
[WARNING] public static Automaton makeInterval(int min, int max, int digits) throws IllegalArgumentException {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:768: warning: no @param for s
[WARNING] public static Automaton makeString(String s) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:768: warning: no @return
[WARNING] public static Automaton makeString(String s) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:775: warning: no @param for strings
[WARNING] public static Automaton makeStringUnion(CharSequence... strings) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:775: warning: no @return
[WARNING] public static Automaton makeStringUnion(CharSequence... strings) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:782: warning: no @param for n
[WARNING] public static Automaton makeMaxInteger(String n) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:782: warning: no @return
[WARNING] public static Automaton makeMaxInteger(String n) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:789: warning: no @param for n
[WARNING] public static Automaton makeMinInteger(String n) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:789: warning: no @return
[WARNING] public static Automaton makeMinInteger(String n) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:796: warning: no @param for i
[WARNING] public static Automaton makeTotalDigits(int i) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:796: warning: no @return
[WARNING] public static Automaton makeTotalDigits(int i) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:803: warning: no @param for i
[WARNING] public static Automaton makeFractionDigits(int i) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:803: warning: no @return
[WARNING] public static Automaton makeFractionDigits(int i) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:810: warning: no @param for value
[WARNING] public static Automaton makeIntegerValue(String value) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:810: warning: no @return
[WARNING] public static Automaton makeIntegerValue(String value) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:817: warning: no @param for value
[WARNING] public static Automaton makeDecimalValue(String value) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:817: warning: no @return
[WARNING] public static Automaton makeDecimalValue(String value) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:824: warning: no @param for s
[WARNING] public static Automaton makeStringMatcher(String s) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:824: warning: no @return
[WARNING] public static Automaton makeStringMatcher(String s) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:831: warning: no @param for a
[WARNING] public Automaton concatenate(Automaton a) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:831: warning: no @return
[WARNING] public Automaton concatenate(Automaton a) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:838: warning: no @param for l
[WARNING] static public Automaton concatenate(List<Automaton> l) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:838: warning: no @return
[WARNING] static public Automaton concatenate(List<Automaton> l) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:845: warning: no @return
[WARNING] public Automaton optional() {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:852: warning: no @return
[WARNING] public Automaton repeat() {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:859: warning: no @param for min
[WARNING] public Automaton repeat(int min) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:859: warning: no @return
[WARNING] public Automaton repeat(int min) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:866: warning: no @param for min
[WARNING] public Automaton repeat(int min, int max) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:866: warning: no @param for max
[WARNING] public Automaton repeat(int min, int max) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:866: warning: no @return
[WARNING] public Automaton repeat(int min, int max) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:873: warning: no @return
[WARNING] public Automaton complement() {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:880: warning: no @param for a
[WARNING] public Automaton minus(Automaton a) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:880: warning: no @return
[WARNING] public Automaton minus(Automaton a) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:887: warning: no @param for a
[WARNING] public Automaton intersection(Automaton a) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:887: warning: no @return
[WARNING] public Automaton intersection(Automaton a) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:894: warning: no @param for a
[WARNING] public boolean subsetOf(Automaton a) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:894: warning: no @return
[WARNING] public boolean subsetOf(Automaton a) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:901: warning: no @param for a
[WARNING] public Automaton union(Automaton a) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:901: warning: no @return
[WARNING] public Automaton union(Automaton a) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:908: warning: no @param for l
[WARNING] static public Automaton union(Collection<Automaton> l) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:908: warning: no @return
[WARNING] static public Automaton union(Collection<Automaton> l) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:922: warning: no @param for pairs
[WARNING] public void addEpsilons(Collection<StatePair> pairs) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:929: warning: no @return
[WARNING] public boolean isEmptyString() {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:936: warning: no @return
[WARNING] public boolean isEmpty() {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:943: warning: no @return
[WARNING] public boolean isTotal() {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:950: warning: no @param for accepted
[WARNING] public String getShortestExample(boolean accepted) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:950: warning: no @return
[WARNING] public String getShortestExample(boolean accepted) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:957: warning: no @param for s
[WARNING] public boolean run(String s) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:957: warning: no @return
[WARNING] public boolean run(String s) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:972: warning: no @param for a
[WARNING] public static Automaton minimize(Automaton a) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:972: warning: no @return
[WARNING] public static Automaton minimize(Automaton a) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:980: warning: no @param for a
[WARNING] public Automaton overlap(Automaton a) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:980: warning: no @return
[WARNING] public Automaton overlap(Automaton a) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:987: warning: no @return
[WARNING] public Automaton singleChars() {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:994: warning: no @param for set
[WARNING] public Automaton trim(String set, char c) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:994: warning: no @param for c
[WARNING] public Automaton trim(String set, char c) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:994: warning: no @return
[WARNING] public Automaton trim(String set, char c) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:1001: warning: no @param for set
[WARNING] public Automaton compress(String set, char c) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:1001: warning: no @param for c
[WARNING] public Automaton compress(String set, char c) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:1001: warning: no @return
[WARNING] public Automaton compress(String set, char c) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:1008: warning: no @param for map
[WARNING] public Automaton subst(Map<Character,Set<Character>> map) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:1008: warning: no @return
[WARNING] public Automaton subst(Map<Character,Set<Character>> map) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:1015: warning: no @param for c
[WARNING] public Automaton subst(char c, String s) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:1015: warning: no @param for s
[WARNING] public Automaton subst(char c, String s) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:1015: warning: no @return
[WARNING] public Automaton subst(char c, String s) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:1022: warning: no @param for source
[WARNING] public Automaton homomorph(char[] source, char[] dest) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:1022: warning: no @param for dest
[WARNING] public Automaton homomorph(char[] source, char[] dest) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:1022: warning: no @return
[WARNING] public Automaton homomorph(char[] source, char[] dest) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:1029: warning: no @param for chars
[WARNING] public Automaton projectChars(Set<Character> chars) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:1029: warning: no @return
[WARNING] public Automaton projectChars(Set<Character> chars) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:1036: warning: no @return
[WARNING] public boolean isFinite() {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:1043: warning: no @param for length
[WARNING] public Set<String> getStrings(int length) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:1043: warning: no @return
[WARNING] public Set<String> getStrings(int length) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:1050: warning: no @return
[WARNING] public Set<String> getFiniteStrings() {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:1057: warning: no @param for limit
[WARNING] public Set<String> getFiniteStrings(int limit) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:1057: warning: no @return
[WARNING] public Set<String> getFiniteStrings(int limit) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:1064: warning: no @return
[WARNING] public String getCommonPrefix() {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:1078: warning: no @param for a
[WARNING] public static Automaton hexCases(Automaton a) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:1078: warning: no @return
[WARNING] public static Automaton hexCases(Automaton a) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:1085: warning: no @param for a
[WARNING] public static Automaton replaceWhitespace(Automaton a) {
[WARNING] ^
[WARNING] /Users/lmcgibbn/Downloads/dk.brics.automaton/src/dk/brics/automaton/Automaton.java:1085: warning: no @return
[WARNING] public static Automaton replaceWhitespace(Automaton a) {
[WARNING] ^
[INFO] Building jar: /Users/lmcgibbn/Downloads/dk.brics.automaton/target/automaton-1.12-2-javadoc.jar
lewismc commented 3 years ago

I'm not really best positioned to provide all of this documentation... but I will give it a go.