Pete Gonzalez

Results 561 comments of Pete Gonzalez

Should multiple decorators be represented using multiple `@decorator` tags? How should it be displayed in the API docs? Here's an example input: ```ts /** * Used to change the sign...

Here's a PR: https://github.com/microsoft/tsdoc/pull/272

🤔 Given that most TSDoc tags are block tags, maybe by default `@custom` should be interpreted as a block tag.

The TSDoc playground doesn't include a TypeScript compiler at all. (One of the "features" of the **\@microsoft/tsdoc** library is that it's completely self-contained and doesn't require any other library dependencies....

Here's the other example that @Wenzil gave in #116: ```ts /** * Some sample class */ export class MyClass { /** * Returns the average of two numbers. */ getAverage(x,...

Alternatively, we could actually support full TypeScript source files as input. Maybe the "HTML" tab would dynamically change to render whatever comment your cursor was inside. That's probably a much...

If the playground code sample looked like this: ``` /** * Returns the average of two numbers. * * @remarks * This method is part of the {@link core-library#Statistics |...

Hmmm... I had not thought of this requirement, where you want to work in TypeScript but accomodate developers who code in plain JavaScript. But if I were doing that, I...

@fastfedo encountered the same confusion in https://github.com/Microsoft/tsdoc/issues/152#issuecomment-474026798 . He gave a couple suggestions: > Two things might have helped me here: > > 1. Documentation examples in/linked from the README...

It also seems related to this JSDoc issue: https://github.com/jsdoc/jsdoc/issues/1286 And this more general TSDoc discussion: https://github.com/microsoft/tsdoc/issues/241 I have not thought about this much myself. It would be helpful for someone...