Skip to content

feat: ✨ convert Javadoc anchor tags to TSdoc links#888

Open
tonjohn wants to merge 2 commits intovojtechhabarta:mainfrom
tonjohn:main
Open

feat: ✨ convert Javadoc anchor tags to TSdoc links#888
tonjohn wants to merge 2 commits intovojtechhabarta:mainfrom
tonjohn:main

Conversation

@tonjohn
Copy link
Copy Markdown

@tonjohn tonjohn commented Sep 22, 2022

Fixes #887

Example

Given:

/**
 * Represents a hamburger (food) 🍔
 *
 * @see <a href=
 *      "https://en.wikipedia.org/wiki/Hamburger">Hamburger - Wikipedia</a>
 */
@Data
public class Hamburger {
	private String name;
	private @Nullable String description;
	private ArrayList<String> ingredients;
}

image

Before:

/**
 * Represents a hamburger (food) 🍔
 * @see <a href=
 *      "https://en.wikipedia.org/wiki/Hamburger">Hamburger - Wikipedia</a>
 */
interface Hamburger {
  readonly name: string;
  readonly description?: string;
  readonly ingredients: string[];
}

image

After:

/**
 * Represents a hamburger (food) 🍔
 * @see {@link https://en.wikipedia.org/wiki/Hamburger Hamburger - Wikipedia}
 */
interface Hamburger {
  readonly name: string;
  readonly description?: string;
  readonly ingredients: string[];
}

image

@JamesIves
Copy link
Copy Markdown

Big +1 to this

Copy link
Copy Markdown

@Allysony Allysony left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 to this too! I'd love to have usable TSdoc links.

@@ -256,11 +256,11 @@ private List<String> getComments(String dComments, List<TagInfo> tags) {
.replaceAll("\\s*<br />\\s*", nn)
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

data analyst can be reformed using a wiper

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Convert javadoc anchor tags to tsdoc @link

4 participants