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

Convert javadoc anchor tags to tsdoc @link #887

Open
tonjohn opened this issue Sep 22, 2022 · 0 comments · May be fixed by #888
Open

Convert javadoc anchor tags to tsdoc @link #887

tonjohn opened this issue Sep 22, 2022 · 0 comments · May be fixed by #888

Comments

@tonjohn
Copy link

tonjohn commented Sep 22, 2022

External links in Javadoc comments do not get converted to their TSdoc equivalent. This results in either having to author non-compliant Javadoc links that IntelliJ warns about or not having usable links in TSdocs which can be confusing.

Given:

/**
 * Represents a hamburger (food) 🍔
 *
 * @see <a href=
 *      "https://en.wikipedia.org/wiki/Hamburger">Hamburger - Wikipedia</a>
 */
@Data
public class Hamburger {

	/**
	 * The name of the hamburger as it appears to customers
	 */
	private String name;

	/**
	 * The description of the hamburger
	 */
	private @Nullable String description;

	/**
	 * List of ingredients
	 */
	private ArrayList<String> ingredients;
}

image

Expected:

/**
 * 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

Actual:

/**
 * 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
@tonjohn tonjohn linked a pull request Sep 22, 2022 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: ✨ convert Javadoc anchor tags to TSdoc links tonjohn/typescript-generator-tsdoc-link
1 participant
@tonjohn