Fix javadoc custom tag warning (#8502)
authormudathirmahgoub <mudathirmahgoub@gmail.com>
Fri, 1 Apr 2022 09:33:14 +0000 (04:33 -0500)
committerGitHub <noreply@github.com>
Fri, 1 Apr 2022 09:33:14 +0000 (09:33 +0000)
Fix this warning
Note: Custom tags that could override future standard tags:  @apiNote. To avoid potential overrides, use at least one period character (.) in custom tag names.

docs/api/java/CMakeLists.txt
src/api/java/io/github/cvc5/Datatype.java
src/api/java/io/github/cvc5/DatatypeConstructor.java
src/api/java/io/github/cvc5/Solver.java
src/api/java/io/github/cvc5/Sort.java
src/api/java/io/github/cvc5/Term.java

index def6524be100bc2748de5cfe5dd69e563b7e5314..8150deff337324cd348c03e0dd58fff8a5079268 100644 (file)
@@ -31,7 +31,7 @@ if(BUILD_BINDINGS_JAVA)
       -sourcepath ${CMAKE_SOURCE_DIR}/src/api/java/:${CMAKE_BINARY_DIR}/src/api/java/
       -d ${JAVADOC_OUTPUT_DIR}
       -cp ${CVC5_JAR_FILE}
-      -tag "apiNote:a:Note:"
+      -tag "api.note:a:Note:"
       -notimestamp
     COMMAND find ${JAVADOC_OUTPUT_DIR} -type f -exec sed -i'orig' 's/<!-- Generated by javadoc [^>]* -->//' {} "\;"
     COMMAND find ${SPHINX_GH_OUTPUT_DIR} -name '*orig' -delete
index 677ae79096e4078afbbba6e49aacbebb485080ec..cfe0614ef313ecdd60e2b77ef32f4928ec107ab3 100644 (file)
@@ -111,7 +111,7 @@ public class Datatype extends AbstractPointer implements Iterable<DatatypeConstr
   private native int getNumConstructors(long pointer);
 
   /**
-   * @apiNote This method is experimental and may change in future versions.
+   * @api.note This method is experimental and may change in future versions.
    *
    * @return the parameters of this datatype, if it is parametric. An exception
    * is thrown if this datatype is not parametric.
@@ -126,7 +126,7 @@ public class Datatype extends AbstractPointer implements Iterable<DatatypeConstr
   private native long[] getParameters(long pointer);
 
   /**
-   * @apiNote This method is experimental and may change in future versions.
+   * @api.note This method is experimental and may change in future versions.
    *
    * @return true if this datatype is parametric
    */
@@ -154,7 +154,7 @@ public class Datatype extends AbstractPointer implements Iterable<DatatypeConstr
   private native boolean isTuple(long pointer);
 
   /**
-   * @apiNote This method is experimental and may change in future versions.
+   * @api.note This method is experimental and may change in future versions.
    *
    * @return true if this datatype corresponds to a record
    */
index e7d8182f97494cc135257a750af4556627255af7..c8bff090051dd612128c78309e716c71def78907 100644 (file)
@@ -75,7 +75,7 @@ public class DatatypeConstructor extends AbstractPointer implements Iterable<Dat
    * while Solver::mkTerm(APPLY_CONSTRUCTOR, t) is used to construct the above
    * (nullary) application of nil.
    *
-   * @apiNote This method is experimental and may change in future versions.
+   * @api.note This method is experimental and may change in future versions.
    *
    * @param retSort the desired return sort of the constructor
    * @return the constructor term
index 92d444fe7d222b7cd455a30aaa65f35f15ad6083..ea4bc5f1169e4f9295ecf72f66ae6a68c4a327b0 100644 (file)
@@ -261,7 +261,7 @@ public class Solver implements IPointer, AutoCloseable
    * datatype sort constructed for the datatype declaration it is associated
    * with.
    *
-   * @apiNote Create unresolved sorts with Solver::mkUnresolvedSort().
+   * @api.note Create unresolved sorts with Solver::mkUnresolvedSort().
    *
    * @param dtypedecls the datatype declarations from which the sort is
    *     created
@@ -338,7 +338,7 @@ public class Solver implements IPointer, AutoCloseable
   /**
    * Create a sort parameter.
    *
-   * @apiNote This method is experimental and may change in future versions.
+   * @api.note This method is experimental and may change in future versions.
    *
    * @param symbol the name of the sort
    * @return the sort parameter
@@ -354,7 +354,7 @@ public class Solver implements IPointer, AutoCloseable
   /**
    * Create a sort parameter.
    *
-   * @apiNote This method is experimental and may change in future versions.
+   * @api.note This method is experimental and may change in future versions.
    *
    * @return the sort parameter
    */
@@ -382,7 +382,7 @@ public class Solver implements IPointer, AutoCloseable
   /**
    * Create a record sort
    *
-   * @apiNote This method is experimental and may change in future versions.
+   * @api.note This method is experimental and may change in future versions.
    *
    * @param fields the list of fields of the record
    * @return the record sort
@@ -740,7 +740,7 @@ public class Solver implements IPointer, AutoCloseable
    * The Kind may not be the Kind for an indexed operator
    *   (e.g. BITVECTOR_EXTRACT).
    *
-   * @apiNote In this case, the Op simply wraps the Kind. The Kind can be used
+   * @api.note In this case, the Op simply wraps the Kind. The Kind can be used
    *          in mkTerm directly without creating an op first.
    *
    * @param kind the kind to wrap
@@ -1018,7 +1018,7 @@ public class Solver implements IPointer, AutoCloseable
   /**
    * Create a separation logic empty term.
    *
-   * @apiNote This method is experimental and may change in future versions.
+   * @api.note This method is experimental and may change in future versions.
    *
    * @return the separation logic empty term
    */
@@ -1033,7 +1033,7 @@ public class Solver implements IPointer, AutoCloseable
   /**
    * Create a separation logic nil term.
    *
-   * @apiNote This method is experimental and may change in future versions.
+   * @api.note This method is experimental and may change in future versions.
    *
    * @param sort the sort of the nil term
    * @return the separation logic nil term
@@ -1128,7 +1128,7 @@ public class Solver implements IPointer, AutoCloseable
   /**
    * Create a bit-vector constant of given size and value.
    *
-   * @apiNote The given value must fit into a bit-vector of the given size.
+   * @api.note The given value must fit into a bit-vector of the given size.
    *
    * @param size the bit-width of the bit-vector sort
    * @param val the value of the constant
@@ -1149,7 +1149,7 @@ public class Solver implements IPointer, AutoCloseable
    * Create a bit-vector constant of a given bit-width from a given string of
    * base 2, 10 or 16.
    *
-   * @apiNote The given value must fit into a bit-vector of the given size.
+   * @api.note The given value must fit into a bit-vector of the given size.
    *
    * @param size the bit-width of the constant
    * @param s the string representation of the constant
@@ -1297,7 +1297,7 @@ public class Solver implements IPointer, AutoCloseable
   /**
    * Create a cardinality constraint for an uninterpreted sort.
    *
-   * @apiNote This method is experimental and may change in future versions.
+   * @api.note This method is experimental and may change in future versions.
    *
    * @param sort the sort the cardinality constraint is for
    * @param upperBound the upper bound on the cardinality of the sort
@@ -1504,7 +1504,7 @@ public class Solver implements IPointer, AutoCloseable
    * definitions, assertions, and the current partial model, if one
    * has been constructed.  It also involves theory normalization.
    *
-   * @apiNote This method is experimental and may change in future versions.
+   * @api.note This method is experimental and may change in future versions.
    *
    * @param t the formula to simplify
    * @return the simplified formula
@@ -1629,7 +1629,7 @@ public class Solver implements IPointer, AutoCloseable
    *   ( declare-sort <symbol> <numeral> )
    * }
    *
-   * @apiNote This corresponds to mkUninterpretedSort() const if arity = 0, and
+   * @api.note This corresponds to mkUninterpretedSort() const if arity = 0, and
    *          to mkUninterpretedSortConstructorSort() const if arity &gt; 0.
    *
    * @param symbol the name of the sort
@@ -1830,7 +1830,7 @@ public class Solver implements IPointer, AutoCloseable
    * ( get-learned-literals )
    * }
    *
-   * @apiNote This method is experimental and may change in future versions.
+   * @api.note This method is experimental and may change in future versions.
    *
    * @return the list of learned literals
    */
@@ -1936,7 +1936,7 @@ public class Solver implements IPointer, AutoCloseable
    * }
    * Requires to enable option 'produce-unsat-cores'.
    *
-   * @apiNote In contrast to SMT-LIB, the API does not distinguish between
+   * @api.note In contrast to SMT-LIB, the API does not distinguish between
    *          named and unnamed assertions when producing an unsatisfiable
    *          core. Additionally, the API allows this option to be called after
    *          a check with assumptions. A subset of those assumptions may be
@@ -1956,7 +1956,7 @@ public class Solver implements IPointer, AutoCloseable
    * Get a difficulty estimate for an asserted formula. This method is
    * intended to be called immediately after any response to a checkSat.
    *
-   * @apiNote This method is experimental and may change in future versions.
+   * @api.note This method is experimental and may change in future versions.
    *
    * @return a map from (a subset of) the input assertions to a real value that
    * is an estimate of how difficult each assertion was to solve. Unmentioned
@@ -1985,7 +1985,7 @@ public class Solver implements IPointer, AutoCloseable
    * }
    * Requires to enable option 'produce-proofs'.
    *
-   * @apiNote This method is experimental and may change in future versions.
+   * @api.note This method is experimental and may change in future versions.
    *
    * @return a string representing the proof, according to the value of
    * proof-format-mode.
@@ -2054,7 +2054,7 @@ public class Solver implements IPointer, AutoCloseable
    * current model. This method will only return false (for any v) if
    * the model-cores option has been set.
    *
-   * @apiNote This method is experimental and may change in future versions.
+   * @api.note This method is experimental and may change in future versions.
    *
    * @param v The term in question
    * @return true if v is a model core symbol
@@ -2074,7 +2074,7 @@ public class Solver implements IPointer, AutoCloseable
    * }
    * Requires to enable option 'produce-models'.
    *
-   * @apiNote This method is experimental and may change in future versions.
+   * @api.note This method is experimental and may change in future versions.
    *
    * @param sorts The list of uninterpreted sorts that should be printed in the
    * model.
@@ -2100,7 +2100,7 @@ public class Solver implements IPointer, AutoCloseable
    * Quantifier Elimination is is only complete for logics such as LRA,
    * LIA and BV.
    *
-   * @apiNote This method is experimental and may change in future versions.
+   * @api.note This method is experimental and may change in future versions.
    *
    * @param q a quantified formula of the form:
    *   Q x1...xn. P( x1...xn, y1...yn )
@@ -2129,7 +2129,7 @@ public class Solver implements IPointer, AutoCloseable
    * Quantifier Elimination is is only complete for logics such as LRA,
    * LIA and BV.
    *
-   * @apiNote This method is experimental and may change in future versions.
+   * @api.note This method is experimental and may change in future versions.
    *
    * @param q a quantified formula of the form:
    *   Q x1...xn. P( x1...xn, y1...yn )
@@ -2162,7 +2162,7 @@ public class Solver implements IPointer, AutoCloseable
    * datatype sort to the given ones. This method should be invoked exactly
    * once, before any separation logic constraints are provided.
    *
-   * @apiNote This method is experimental and may change in future versions.
+   * @api.note This method is experimental and may change in future versions.
    *
    * @param locSort The location sort of the heap
    * @param dataSort The data sort of the heap
@@ -2177,7 +2177,7 @@ public class Solver implements IPointer, AutoCloseable
   /**
    * When using separation logic, obtain the term for the heap.
    *
-   * @apiNote This method is experimental and may change in future versions.
+   * @api.note This method is experimental and may change in future versions.
    *
    * @return The term for the heap
    */
@@ -2192,7 +2192,7 @@ public class Solver implements IPointer, AutoCloseable
   /**
    * When using separation logic, obtain the term for nil.
    *
-   * @apiNote This method is experimental and may change in future versions.
+   * @api.note This method is experimental and may change in future versions.
    *
    * @return The term for nil
    */
@@ -2211,7 +2211,7 @@ public class Solver implements IPointer, AutoCloseable
    * ( declare-pool <symbol> <sort> ( <term>* ) )
    * }
    *
-   * @apiNote This method is experimental and may change in future versions.
+   * @api.note This method is experimental and may change in future versions.
    *
    * @param symbol The name of the pool
    * @param sort The sort of the elements of the pool.
@@ -2265,7 +2265,7 @@ public class Solver implements IPointer, AutoCloseable
    * }
    * Requires 'produce-interpolants' to be set to a mode different from 'none'.
    *
-   * @apiNote This method is experimental and may change in future versions.
+   * @api.note This method is experimental and may change in future versions.
    *
    * @param conj the conjecture term
    * @return a Term I such that {@code A->I} and {@code I->B} are valid, where
@@ -2288,7 +2288,7 @@ public class Solver implements IPointer, AutoCloseable
    * }
    * Requires 'produce-interpolants' to be set to a mode different from 'none'.
    *
-   * @apiNote This method is experimental and may change in future versions.
+   * @api.note This method is experimental and may change in future versions.
    *
    * @param conj the conjecture term
    * @param grammar the grammar for the interpolant I
@@ -2321,7 +2321,7 @@ public class Solver implements IPointer, AutoCloseable
    * set to a mode different from 'none'.
    * \endverbatim
    *
-   * @apiNote This method is experimental and may change in future versions.
+   * @api.note This method is experimental and may change in future versions.
    *
    * @return a Term I such that {@code A->I} and {@code I->B} are valid,
    *        where A is the current set of assertions and B is given in the input
@@ -2344,7 +2344,7 @@ public class Solver implements IPointer, AutoCloseable
    * }
    * Requires enabling option 'produce-abducts'
    *
-   * @apiNote This method is experimental and may change in future versions.
+   * @api.note This method is experimental and may change in future versions.
    *
    * @param conj the conjecture term
    * @return a term C such that A^C is satisfiable, and A^~B^C is
@@ -2367,7 +2367,7 @@ public class Solver implements IPointer, AutoCloseable
    * }
    * Requires enabling option 'produce-abducts'
    *
-   * @apiNote This method is experimental and may change in future versions.
+   * @api.note This method is experimental and may change in future versions.
    *
    * @param conj the conjecture term
    * @param grammar the grammar for the abduct C
@@ -2394,7 +2394,7 @@ public class Solver implements IPointer, AutoCloseable
    * }
    * Requires enabling incremental mode and option 'produce-abducts'
    *
-   * @apiNote This method is experimental and may change in future versions.
+   * @api.note This method is experimental and may change in future versions.
    *
    * @return a term C such that A^C is satisfiable, and A^~B^C is
    *         unsatisfiable, where A is the current set of assertions and B is
@@ -2419,7 +2419,7 @@ public class Solver implements IPointer, AutoCloseable
    * Requires enabling 'produce-models' option and setting 'block-models' option
    * to a mode other than "none".
    *
-   * @apiNote This method is experimental and may change in future versions.
+   * @api.note This method is experimental and may change in future versions.
    */
   public void blockModel()
   {
@@ -2437,7 +2437,7 @@ public class Solver implements IPointer, AutoCloseable
    * }
    * Requires enabling 'produce-models' option.
    *
-   * @apiNote This method is experimental and may change in future versions.
+   * @api.note This method is experimental and may change in future versions.
    */
   public void blockModelValues(Term[] terms)
   {
@@ -2451,7 +2451,7 @@ public class Solver implements IPointer, AutoCloseable
    * Return a string that contains information about all instantiations made by
    * the quantifiers module.
    *
-   * @apiNote This method is experimental and may change in future versions.
+   * @api.note This method is experimental and may change in future versions.
    */
   public String getInstantiations()
   {
index 64fcbb56b72df68573fef61d5168b2e57502b9d9..65ff8e49d9227913d428c13080546d6b78d185a9 100644 (file)
@@ -283,7 +283,7 @@ public class Sort extends AbstractPointer implements Comparable<Sort>
   /**
    * Is this a record sort?
    *
-   * @apiNote This method is experimental and may change in future versions.
+   * @api.note This method is experimental and may change in future versions.
    *
    * @return true if the sort is a record sort
    */
@@ -426,7 +426,7 @@ public class Sort extends AbstractPointer implements Comparable<Sort>
    *
    * Create sorts parameter with Solver.mkParamSort().
    *
-   * @apiNote This method is experimental and may change in future versions.
+   * @api.note This method is experimental and may change in future versions.
    *
    * @param params the list of sort parameters to instantiate with
    */
@@ -461,7 +461,7 @@ public class Sort extends AbstractPointer implements Comparable<Sort>
    * Note that this replacement is applied during a pre-order traversal and
    * only once to the sort. It is not run until fix point.
    *
-   * @apiNote This method is experimental and may change in future versions.
+   * @api.note This method is experimental and may change in future versions.
    *
    * @param sort the subsort to be substituted within this sort.
    * @param replacement the sort replacing the substituted subsort.
@@ -486,7 +486,7 @@ public class Sort extends AbstractPointer implements Comparable<Sort>
    * (Array A B).substitute({A, C}, {(Array C D), (Array A B)}) will
    * return (Array (Array C D) B).
    *
-   * @apiNote This method is experimental and may change in future versions.
+   * @api.note This method is experimental and may change in future versions.
    *
    * @param sorts the subsorts to be substituted within this sort.
    * @param replacements the sort replacing the substituted subsorts.
index 46363251fe5b68688c16d050801a3a5133793c60..a0a0620ace5b8d6e80db099480742733ad3e5c08 100644 (file)
@@ -202,7 +202,7 @@ public class Term extends AbstractPointer implements Comparable<Term>, Iterable<
 
   /**
    * @return the Op used to create this term
-   * @apiNote This is safe to call when hasOp() returns true.
+   * @api.note This is safe to call when hasOp() returns true.
    */
   public Op getOp()
   {
@@ -395,7 +395,7 @@ public class Term extends AbstractPointer implements Comparable<Term>, Iterable<
    *
    * Asserts isString().
    *
-   * @apiNote This method is not to be confused with toString() which returns
+   * @api.note This method is not to be confused with toString() which returns
    *          the term in some string representation, whatever data it may hold.
    */
   public String getStringValue()
@@ -671,7 +671,7 @@ public class Term extends AbstractPointer implements Comparable<Term>, Iterable<
 
   /**
    * Asserts isSequenceValue().
-   * @apiNote It is usually necessary for sequences to call
+   * @api.note It is usually necessary for sequences to call
    *          `Solver::simplify()` to turn a sequence that is constructed by,
    *          e.g., concatenation of unit sequences, into a sequence value.
    * @return the representation of a sequence value as a vector of terms.