search

Drarig29 / brackets-manager.js

A simple library to manage tournament brackets (round-robin, single elimination, double elimination).
https://drarig29.github.io/brackets-docs
MIT License
245 stars 38 forks source link

TypeDoc should have comprehensive definition #164

Closed mikhail closed 1 year ago

mikhail commented 1 year ago

Current TypeDocs are minimal with inline comments in the body of the interfaces.

This is inconvenient because it requires reading the source code instead of relying on the IDE (IntelliJ in this case). See bottom right -- only includes a single comment.

image

Request here is to list all parameters ( @param ) in the typedoc ( https://typedoc.org/tags/param/#example )

Drarig29 commented 1 year ago

This is totally normal and I can't do anything about it. The @param tag in TSDoc is for the parameters of a function.

What you are asking here is to list the properties of an interface. This would be pure duplication, and wrong.

mikhail commented 1 year ago

Thanks for looking into it. What's the right way to make it work with the ide? Having to open library source seems wrong as well.

Drarig29 commented 1 year ago

The only way to explore the documentation for the properties of an interface without looking at the source code is by reading the property autocompletion:

image

In this case, since your IDE knows the function's argument is an InputStage, then it shows you the expected properties (with their documentation).

If you are not using a function that takes an InputStage as argument, then you can just create a dummy object and autocomplete its properties:

image

This is VSCode but it should work the same in IntelliJ. And that's usual in TypeScript :smile: