Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

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

wants to merge 2 commits into from

Conversation

tonjohn
Copy link

@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

Big +1 to this

Allysony
Allysony approved these changes Sep 22, 2022
View reviewed changes
Copy link

@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.

durgasatti
durgasatti reviewed Dec 5, 2022
View reviewed changes
typescript-generator-core/src/main/java/cz/habarta/typescript/generator/parser/Javadoc.java
@@ -256,11 +256,11 @@ private List<String> getComments(String dComments, List<TagInfo> tags) {
.replaceAll("\\s*<br />\\s*", nn)
Copy link

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
Reviewers

@durgasatti durgasatti durgasatti left review comments

@Allysony Allysony Allysony approved these changes

@JamesIves JamesIves JamesIves approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Convert javadoc anchor tags to tsdoc @link
4 participants
@tonjohn @JamesIves @Allysony @durgasatti