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

Typedoc warnings for locations where namespace THREE is being used in r169 #1301

Open
AdilRabbani opened this issue Oct 23, 2024 · 1 comment

Comments

@AdilRabbani
Copy link

AdilRabbani commented Oct 23, 2024

Hi 👋 I just switched to r169 from r156 and noticed that typedoc is giving a warning for the Camera class. I am getting this:

[warning] Failed to resolve link to "THREE.PerspectiveCamera | PerspectiveCamera" in comment for ...render-pass.BaseCamera.constructor.
[warning] Failed to resolve link to "THREE.OrthographicCamera | OrthographicCamera" in comment for ...render-pass.BaseCamera.constructor..BaseCamera.constructor.

The reason it happens for me is because I am extending the Camera class to create my own BaseCamera class like this:

export class BaseCamera extends Camera { }

But I believe typedoc would give this warning for every other doc-string where namespace THREE is being used since this namespace has entirely been removed. Is it possible to update the doc-strings so that they are typedoc compliant? :) Also let me know if its something wrong on my side or I should approach this differently. Thanks! 🙏

PS. I can also volunteer to fix the links so that they don't use the THREE namespace anymore.

@AdilRabbani AdilRabbani changed the title Typedoc failing for locations where namespace THREE is being used in r169 Typedoc warnings for locations where namespace THREE is being used in r169 Oct 23, 2024
@Methuselah96
Copy link
Contributor

Hi, thanks for the issue!

If you would like to open a PR to fix those, that would be great, thanks!

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