Skip to content
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/examples/en/loaders/GLTFLoader.html
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,8 @@ <h2>Extensions</h2>
<ul>
<li>[link:https://github.com/takahirox/three-gltf-extensions KHR_materials_variants]<sup>1</sup></li>
<li>[link:https://github.com/takahirox/three-gltf-extensions MSFT_texture_dds]</li>
<li>[link:https://github.com/needle-tools/three-animation-pointer KHR_animation_pointer]</li>
<li>[link:https://github.com/needle-tools/gltf-progressive NEEDLE_progressive]</li>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add the comments here as well:

* The following glTF 2.0 extension is supported by an external user plugin:
* - [KHR_materials_variants]{@link https://github.com/takahirox/three-gltf-extensions}
* - [MSFT_texture_dds]{@link https://github.com/takahirox/three-gltf-extensions}

The "old" docs will be replaced with a new one generated from the JSDoc.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh sounds perfect! I just did

Copy link
Contributor Author

@marwie marwie Oct 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the code preview format intended like that?

image

Why not like this ?
- [KHR_animation_pointer](<url>)
or - [KHR_animation_pointer]({@link <url>})

image

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is JSDoc still able to parse [KHR_animation_pointer](<url>)?

You can test this by running npm run build-docs and then open the doc page via http://localhost:8080/docs_new/#GLTFLoader.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Merging in the meanwhile. If we update the style of external links, we should do this everywhere.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[KHR_animation_pointer]({@link <url>})

This style does not seem to work.

image

[KHR_animation_pointer](<url>)

With this style, the links in the source code are not highlighted and clickable anymore since it's just text.

So none of the approaches is ideal.

Copy link
Contributor Author

@marwie marwie Oct 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How/where did you try the style that doesnt work?

I've just double checked the GLTFLoader page and this works for me in the docs HTML and code docs suggestion in vscode: [NEEDLE_progressive](<url>).

Links are clickable in both cases.

 * - [NEEDLE_progressive](https://github.com/needle-tools/gltf-progressive)
Screenshot 2025-10-28 at 00 53 12 Screenshot 2025-10-28 at 00 52 49

Tried with the CCD Algorithm that you showed above:

 * This class solves the Inverse Kinematics Problem with a [CCD Algorithm](https://web.archive.org/web/20221206080850/https://sites.google.com/site/auraliusproject/ccd-algorithm).
Screenshot 2025-10-28 at 00 56 14 Screenshot 2025-10-28 at 00 56 44

Let me know if I'm missing anything.

I can make a PR with all links replaced if it helps testing.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What I meant was this:

image

With the current style, you can use cmd + click in VSCode to open the link. This does not work with the second style since the link is just text.

Copy link
Contributor Author

@marwie marwie Oct 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It does work for me holding CMD and clicking the same way as before

Screenshot 2025-10-28 at 01 56 32
test.mp4

Copy link
Collaborator

@Mugen87 Mugen87 Oct 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, you are right! The code just looses the highlighting but the link is still clickable.

In this case, the [title](<url>) seems the overall better approach.

</ul>

<p><i>
Expand Down