Pete Gonzalez

Results 706 comments of Pete Gonzalez

Is there ever a legitimate reason to have two TDoc comments for the same API item? In your example, I'm thinking that `/** Comment two */` should be used, and...

> I just realized, this is at least very closely related to #6, more probably a duplicate, but I'll leave that choice to the maintainers. @Gerrit0 These contributions are very...

Declaration merging is a more interesting case. However my opinion is that the documentation tool should somehow enforce that there is only one doc comment. Trying to merge doc comments...

@iansan5653 raised this question again in https://github.com/microsoft/tsdoc/issues/201: > Thanks for the info. Maybe we should introduce some notion of tags that typically form a group? For example, all `@param` tags...

And here's an example of "compressed" param/returns: ```ts /** * The summary comes first. * * @remarks * The `@remarks` tag always goes on its own line. It appears immediately...

Good points, thanks @Gerrit0 !

Something like this: ```ts /** * Describes a JavaScript object that specifies the configuration of a square. * @remarks * Use this interface with the {@link Renderer.drawShape} method. * @public...

As far as TSDoc goes, I think we would prefer to fix VS Code so that it properly displays the documentation for the interface members. Whereas if we were to...

We might start by making a TSDoc extension for VS Code (similar to the recently released [plugin for ESLint](https://www.npmjs.com/package/eslint-plugin-tsdoc)). This approach would also allow us to render the docs more...

I played around with this a bit today. [Making a VS Code extension](https://code.visualstudio.com/api/get-started/your-first-extension) is very easy to do! In about 30 mins I was able to create a simple prototype...