jleyba / js-dossier

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

"throws" information missing when specified on interface #104

Open myphysicslab opened 7 years ago

myphysicslab commented 7 years ago

For many of my classes the "throws" information on methods is missing. This seems to happen frequently when the "throws" is specified on an interface; the "throws" info will appear in the interface docs, but not in the classes that implement the interface. The rest of the documentation for the method is OK.

Here are some examples.

https://www.myphysicslab.com/develop/docs/myphysicslab.lab.util.HistoryList.html#getEndIndex https://www.myphysicslab.com/develop/docs/myphysicslab.lab.util.CircularList.html#getEndIndex

https://www.myphysicslab.com/develop/docs/myphysicslab.lab.engine2D.Vertex.html#getEdge1 https://www.myphysicslab.com/develop/docs/myphysicslab.lab.engine2D.ConcreteVertex.html#getEdge1

https://www.myphysicslab.com/develop/docs/myphysicslab.lab.model.AdvanceStrategy.html#advance https://www.myphysicslab.com/develop/docs/myphysicslab.lab.model.CollisionAdvance.html#advance

Here is a case where an abstract class is involved. The abstract class is missing the "throws" info but the sub-class SimRunner has it.

https://www.myphysicslab.com/develop/docs/myphysicslab.lab.util.Subject.html#getParameter https://www.myphysicslab.com/develop/docs/myphysicslab.lab.util.AbstractSubject.html#getParameter https://www.myphysicslab.com/develop/docs/myphysicslab.lab.app.SimRunner.html#getParameter

Here is a case where an interface extends another (BTW, the extended interface doesn't show that it is inheriting this method). The extending interface RigidBody is missing the "throws" info, but the concrete class Polygon has it.

https://www.myphysicslab.com/develop/docs/myphysicslab.lab.model.MassObject.html#alignTo https://www.myphysicslab.com/develop/docs/myphysicslab.lab.engine2D.RigidBody.html#alignTo https://www.myphysicslab.com/develop/docs/myphysicslab.lab.engine2D.Polygon.html#alignTo