filament icon indicating copy to clipboard operation
filament copied to clipboard

Docs: In Javascript API reference some links are broken

Open wojciechczerniak opened this issue 2 years ago • 1 comments

Describe the bug Some of linked classes are not exported in the documentation. I tried to read more on AssetLoader methods, but others are not working either: IndirectLight, Skybox. Maybe more, I haven't check all of them.

Screenshot 2022-05-08 112651

To Reproduce Steps to reproduce the behavior:

  1. Open https://google.github.io/filament/webgl/reference.html#Engine
  2. Try to read more on AssetLoader, IndirectLight or Skybox

Expected behavior Have all classes and methods exported to docs and correctly linked

wojciechczerniak avatar May 08 '22 09:05 wojciechczerniak

Thanks, we will soon be removing these docs and instead use the TypeScript bindings as documentation, as described in the comments at https://github.com/google/filament/issues/3250.

prideout avatar May 10 '22 22:05 prideout

@pixelflinger my recommendation is close this and open a new ticket that says: "completely remove our old JavaScript doc system, use tsdoc instead".

In other words, all JavaScript documentation should live in filament.d.ts. The rationale is that the TypeScript declarations file needs to be kept up to date anyway, and it already describes the expected types. It would be the analogue to doxygen/C++ and javadoc/Java.

I don't like the JavaScript doc system that I created years ago because it requires Python (and therefore versioning hell) plus the docstrings are scattered everywhere and hard to maintain.

prideout avatar Oct 31 '22 17:10 prideout