ibm-js / jsdoc-amddcl

An effort to create a JSDoc template that works well with AMD and C3MRO-based multiple class inheritance.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Enhancements for the jsdoc files published on the web

AdrianVasiliu opened this issue · comments

Future improvements over those introduced in #38 may include (as already reported):

  • Skiping the deepest level of {projectname} for the *.html files - additional level which is not present for the generated index.html files.
  • Removing the duplication of *.js.html files (decor's ones duplicated in delite's doc etc.).
  • Support for {version} also in the paths config param, just as it is already supported for packagePathFormat (e.g. f479384#diff-35b4a816e0441e6a375cd925af50752cR89), to avoid the need of manual updates of paths of each Gruntfile.js at each release of a new version.
  • Automatic conversion of relative links in README.md (itself converted into jsdoc's index.html) such as "./LICENSE" into absolute links to the corresponding github files.

The issues are mentioned/discussed more in detail in the comments of asudoh@7a62084 .