search

jleyba / js-dossier

A JavaScript documentation generation tool.
Apache License 2.0
150 stars 15 forks source link

@link doesn't work with goog.module, unless the type has been goog.require-d #106

Open myphysicslab opened 6 years ago

myphysicslab commented 6 years ago

After changing to use goog.module for all classes instead of goog.provide, the @link taglets now only work when the type has been goog.required or defined within a given file. Previously I was able to refer to types that are not goog.required.

As a workaround I can change the @link taglets to markdown-style references to the generated documentation. For example instead of 

{@link myphysicslab.lab.model.MassObject}

I need to write

[myphysicslab.lab.model.MassObject](myphysicslab.lab.model.MassObject.html).
jleyba commented 6 years ago

I noticed this recently too. I know there hasn't been much activity on this project recently - I'm hoping to start working on it again soon. This bug is at the top of my TODO list too.