fix javadoc

Author: wadoon

key.core.example/src/main/java/org/key_project/Main.java

@@ -57,7 +57,7 @@ public static void main(String[] args) {
      *
      * @param location the Path with the path to the source directory of the Java project
      *        to be verified
-     * @return the {@KeYEnvironment} that provides the context for all following verification tasks
+     * @return the {@link KeYEnvironment} that provides the context for all following verification tasks
      * @throws ProblemLoaderException if the setup fails
      */
     private static KeYEnvironment<?> setupEnvironment(Path location) throws ProblemLoaderException {

key.core/src/main/java/de/uka/ilkd/key/java/NameAbstractionTable.java

@@ -43,7 +43,7 @@ public void add(SourceElement pe1, SourceElement pe2) {
      *
      * @param pe0 SourceElement
      * @param pe1 SourceElement
-     * @returns true if the pe1 and pe2 have been assigned to the same name
+     * @return true if the pe1 and pe2 have been assigned to the same name
      */
     public boolean sameAbstractName(SourceElement pe0, SourceElement pe1) {
         if (declarations0 != null) {

key.core/src/main/java/de/uka/ilkd/key/java/Services.java

@@ -453,7 +453,7 @@ public void setFactory(ITermProgramVariableCollectorFactory factory) {
     /**
      * sets the factory for origin term labels
      *
-     * @param originFactory the {@OriginTermLabelFactory} to use, if null is passed, origin labels
+     * @param originFactory the {@link OriginTermLabelFactory} to use, if null is passed, origin labels
      *        should not be created
      */
     public void setOriginFactory(OriginTermLabelFactory originFactory) {

key.core/src/main/java/de/uka/ilkd/key/java/recoderext/MethodBodyStatement.java

@@ -74,7 +74,7 @@ public void setBodySource(TypeReference bodySource) {
     /**
      * Get the exact Class the denoted method body is from.
      *
-     * @returns the TypeReference
+     * @return the TypeReference
      */
 
     public TypeReference getBodySource() {

key.core/src/main/java/de/uka/ilkd/key/scripts/meta/ValueInjector.java

@@ -10,6 +10,7 @@
 import java.util.stream.Collectors;
 
 import de.uka.ilkd.key.scripts.ProofScriptCommand;
+import org.jspecify.annotations.Nullable;
 
 /**
  * @author Alexander Weigl
@@ -252,16 +253,14 @@ public <R, T> void addConverter(Converter<R, T> conv) {
         converters.put(new ConverterKey<>(m.getReturnType(), m.getParameterTypes()[0]), conv);
     }
 
-    /**
-     * Finds a converter for the given class.
-     *
-     * @param <T> an arbitrary type
-     * @param ret a non-null class
-     * @param arg
-     * @return null or a suitable converter (registered) converter for the requested class.
-     */
+    /// Finds a converter for the conversion of `arg` classes to `ret` classes.
+    ///
+    /// @param <T> an arbitrary type
+    /// @param ret target class from which `arg` should be translated
+    /// @param arg class of original class
+    /// @return null or a suitable converter (registered) converter for the requested class.
     @SuppressWarnings("unchecked")
-    public <R, T> Converter<R, T> getConverter(Class<R> ret, Class<T> arg) {
+    public <R, T> @Nullable Converter<R, T> getConverter(Class<R> ret, Class<T> arg) {
         return (Converter<R, T>) converters.get(new ConverterKey<>(ret, arg));
     }
 

key.core/src/main/java/de/uka/ilkd/key/smt/AbstractSMTTranslator.java

@@ -2256,7 +2256,7 @@ protected final StringBuilder translateFunc(Operator o, ArrayList<StringBuilder>
      * translate a bsum function. Alos add the created functionsymbol created depending on the term.
      *
      * @param bsumterm The term used as third argument of the bsum function.
-     * @pram sub The two terms used as first and second argument of the bsum operator.
+     * @param sub The two terms used as first and second argument of the bsum operator.
      * @return
      */
     protected final StringBuilder translateBsumFunction(JTerm bsumterm,
@@ -2294,7 +2294,7 @@ protected final StringBuilder translateBsumFunction(JTerm bsumterm,
      * term.
      *
      * @param bprodterm The term used as third argument of the bsum function.
-     * @pram sub The two terms used as first and second argument of the bsum operator.
+     * @param sub The two terms used as first and second argument of the bsum operator.
      * @return
      */
     protected final StringBuilder translateBprodFunction(JTerm bprodterm,
@@ -2330,7 +2330,7 @@ protected final StringBuilder translateBprodFunction(JTerm bprodterm,
      *
      * @param op the operator used for this function.
      * @param sorts the list of sort parameter of this function
-     * @result the function's result sort
+     * @return the function's result sort
      */
     private void addFunction(Operator op, ArrayList<Sort> sorts, Sort result, Services services) {
         if (!this.functionDecls.containsKey(op)) {

key.core/src/main/java/de/uka/ilkd/key/smt/lang/SMTSort.java

@@ -8,7 +8,7 @@
 /**
  *
  *
- * @authors Aboubakr Achraf El Ghazi and Fikri Kabakcha
+ * @author Aboubakr Achraf El Ghazi, Fikri Kabakcha
  *
  */
 public class SMTSort {

key.core/src/test/java/de/uka/ilkd/key/smt/test/SMTTestCommons.java

@@ -118,7 +118,6 @@ protected ProofAggregate parse(Path file) {
      * @param file problem file.
      * @param pro determines the profile that should be used.
      * @return ProofAggregate of the problem file.
-     * @profile determines the profile that should be used.
      */
     protected ProofAggregate parse(Path file, Profile pro) {
         assertTrue(Files.exists(file));

key.removegenerics/src/main/java/de/uka/ilkd/key/util/removegenerics/ResolveMemberReference.java

@@ -150,12 +150,9 @@ public ProblemReport analyze() {
      * return true iff the reference is a lhs of an assignment: Either an assignment operator or
      * ???.
      *
-     * @todo
-     *
      * @param reference
      * @return true iff the reference is a lhs of an assignment: Either an assignment operator or
      *         ???.
-     *
      */
     private static boolean isLHS(Reference reference) {
         NonTerminalProgramElement parent = reference.getASTParent();
@@ -229,7 +226,7 @@ private Type getFormalType() {
      * <li>MethodReference as parameter</li>
      * </ul>
      *
-     * @todo DAS IST JA WOHL NOCH NICHT
+     * todo DAS IST JA WOHL NOCH NICHT
      *
      * @return the resolved type
      */

key.ui/src/main/java/de/uka/ilkd/key/gui/settings/SettingsPanel.java

@@ -52,8 +52,11 @@ protected SettingsPanel() {
     }
 
     /**
-     * @param info
-     * @return
+     * Factory method for the construction of informational displays using
+     * text areas.
+     *
+     * @param info information to be shown
+     * @return a new {@link JTextArea} showing the given information
      */
     protected static JTextArea createInfoArea(String info) {
         JTextArea textArea = new JTextArea(info);