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.

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

Some @link tags seem to be removed by the API documenter #75

Open
canova opened this issue Oct 16, 2023 · 2 comments
Open

Some @link tags seem to be removed by the API documenter #75

canova opened this issue Oct 16, 2023 · 2 comments
Assignees

Comments

@canova
Copy link

canova commented Oct 16, 2023

Hi, I was looking at the developer documentation and found some deprecated APIs. For example, see the Workspace.activeLeaf property.

It has a warning like this:

Warning: This API is now obsolete.

That makes sense, so my next step was to find out what to use instead. But reading the documentation, it says this:

The recommended alternatives are: - If you need information about the current view, use . - If you need to open a new file or navigate a view, use .

It looks like there were maybe some inline codes or links that were ommited. Paragraph looks like had some information but maybe they were removed by the generator? I can't find the recommended alternatives in this page.

I believe this page is not the only one with this issue. I also came across splitActiveLeaf with missing alternative information.

@canova
Copy link
Author

canova commented Oct 16, 2023

I found the raw API documentation for activeLeaf property here:

* Indicates the currently focused leaf, if one exists.
*
* Please avoid using `activeLeaf` directly, especially without checking whether
* `activeLeaf` is null.
*
* The recommended alternatives are:
* - If you need information about the current view, use {@link getActiveViewOfType}.
* - If you need to open a new file or navigate a view, use {@link getLeaf}.
*
* @public
* @deprecated - The use of this field is discouraged.

It looks like some of the @link tags are being removed.

@canova canova changed the title Some information seems to be removed by the API documenter Some @link tags seem to be removed by the API documenter Oct 16, 2023
@canova canova changed the title Some @link tags seem to be removed by the API documenter Some @link tags seem to be removed by the API documenter Oct 16, 2023
@joethei
Copy link
Contributor

joethei commented Oct 17, 2023

Some instances are fixed now.
For the others I'll have to use some trickery, as support for @label is not implemented yet in api-extractor. (which we need because we have multiple functions with the same name, but different parameters.)

@joethei joethei self-assigned this Oct 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants