hamster-shell-extension icon indicating copy to clipboard operation
hamster-shell-extension copied to clipboard

Published 20 hours ago • verified publisher icon projecthamster

integrate JSDoc docstrings into sphinx docs

Open elbenfreund opened this issue 6 years ago • 1 comments

While the code itself is (partially) documented using JSDoc syntax, our acutal sphinx documentation does not support nor use this. This should be fixed.

elbenfreund avatar Apr 09 '18 11:04 elbenfreund

Our current way to define classes (using imports.Lang features) is not really compatible with JSDocs automated extraction of class methods/properties. Instead of working around this, this issue will be postponed to 0.11.0 when #257 will refactor the way classes are defined in such a way that should play nice with JSDoc/autodoc.

elbenfreund avatar Apr 10 '18 09:04 elbenfreund