Skip to content

Commit

Permalink
refactor: Deprecate old javadoc classes (#5609)
Browse files Browse the repository at this point in the history
  • Loading branch information
MartinWitt authored and I-Al-Istannen committed Apr 3, 2024
1 parent fc8fa02 commit 0fd7324
Show file tree
Hide file tree
Showing 6 changed files with 20 additions and 7 deletions.
17 changes: 10 additions & 7 deletions src/main/java/spoon/javadoc/internal/Javadoc.java
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,16 @@
import spoon.reflect.code.CtComment;

/**
* The structured content of a single Javadoc comment.
*
* <p>It is composed by a description and a list of block tags.
*
* <p>An example would be the text contained in this very Javadoc comment. At the moment of this
* writing this comment does not contain any block tags (such as <code>@see AnotherClass</code>)
*/
* The structured content of a single Javadoc comment.
*
* <p>It is composed by a description and a list of block tags.
*
* <p>An example would be the text contained in this very Javadoc comment. At the moment of this
* writing this comment does not contain any block tags (such as <code>@see AnotherClass</code>)
*
* @deprecated Use the new javadoc parser submodule, see <a href="https://spoon.gforge.inria.fr/spoon_javadoc.html">Javadoc Parser</a>.
*/
@Deprecated(forRemoval = true, since = "11.0.0")
public class Javadoc implements Serializable {
private static final long serialVersionUID = 1L;

Expand Down
2 changes: 2 additions & 0 deletions src/main/java/spoon/javadoc/internal/JavadocBlockTag.java
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@
*
* <p>Examples: <code>@see AnotherClass</code> <code>@since v0.0.1</code> <code>@author Jim O'Java
* </code>
* @deprecated Use the new javadoc parser submodule, see <a href="https://spoon.gforge.inria.fr/spoon_javadoc.html">Javadoc Parser</a>.
*/
@Deprecated(forRemoval = true, since = "11.0.0")
public class JavadocBlockTag implements Serializable {
private static final long serialVersionUID = 1L;

Expand Down
2 changes: 2 additions & 0 deletions src/main/java/spoon/javadoc/internal/JavadocDescription.java
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,9 @@

/**
* A javadoc text, potentially containing inline tags.
* @deprecated Use the new javadoc parser submodule, see <a href="https://spoon.gforge.inria.fr/spoon_javadoc.html">Javadoc Parser</a>.
*/
@Deprecated(forRemoval = true, since = "11.0.0")
public class JavadocDescription implements Serializable {
private static final long serialVersionUID = 1L;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@
*
* <p>So for example <code>a text</code> or <code>{@link String}</code> could be valid description
* elements.
* @deprecated Use the new javadoc parser submodule, see <a href="https://spoon.gforge.inria.fr/spoon_javadoc.html">Javadoc Parser</a>.
*/
@Deprecated(forRemoval = true, since = "11.0.0")
public interface JavadocDescriptionElement {
/** pretty-prints the Javadoc fragment */
String toText();
Expand Down
2 changes: 2 additions & 0 deletions src/main/java/spoon/javadoc/internal/JavadocInlineTag.java
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,9 @@
* An inline tag contained in a Javadoc description.
*
* <p>For example <code>{@link String}</code>
* @deprecated Use the new javadoc parser submodule, see <a href="https://spoon.gforge.inria.fr/spoon_javadoc.html">Javadoc Parser</a>.
*/
@Deprecated(forRemoval = true, since = "11.0.0")
public class JavadocInlineTag implements JavadocDescriptionElement, Serializable {
private static final long serialVersionUID = 1L;

Expand Down
2 changes: 2 additions & 0 deletions src/main/java/spoon/javadoc/internal/JavadocSnippet.java
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,9 @@
*
* <p>For example in <code>A class totally unrelated to {@link String}, I swear!</code> we would
* have two snippets: one before and one after the inline tag (<code>{@link String}</code>).
* @deprecated Use the new javadoc parser submodule, see <a href="https://spoon.gforge.inria.fr/spoon_javadoc.html">Javadoc Parser</a>.
*/
@Deprecated(forRemoval = true, since = "11.0.0")
public class JavadocSnippet implements JavadocDescriptionElement, Serializable {
private static final long serialVersionUID = 1L;
private String text;
Expand Down

0 comments on commit 0fd7324

Please sign in to comment.