We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
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
I really like the JSDOC support, but it's compilation is not optimal when XML tags are used in the C# documentation.
An example with referencing documentation:
public class Menu { /// <summary> /// The dessert recommendations grouped by <see cref="Coffee"/>. /// </summary> public IDictionary<Coffee, string> DessertRecommendations { get; } } public enum Coffee { Black = 1, Americano = 2 }
This is currently serialized to this:
export interface IMenu { /** The dessert recommendations grouped by <see cref="T:Coffee" />. */ dessertRecommendations: { [key in Coffee]: string } } export enum Coffee { ... }
A better serialization would be something like this:
export interface IMenu { /** The dessert recommendations grouped by {@link Coffee}. */ dessertRecommendations: { [key in Coffee]: string } } export enum Coffee { ... }
If JSDoc annotations is unwanted, a simpler but more readable version would be to just remove the XML tags:
export interface IMenu { /** The dessert recommendations grouped by Coffee. */ dessertRecommendations: { [key in Coffee]: string } }
The text was updated successfully, but these errors were encountered:
No branches or pull requests
I really like the JSDOC support, but it's compilation is not optimal when XML tags are used in the C# documentation.
An example with referencing documentation:
This is currently serialized to this:
A better serialization would be something like this:
If JSDoc annotations is unwanted, a simpler but more readable version would be to just remove the XML tags:
The text was updated successfully, but these errors were encountered: