Does sdoc generate documentation for js files ?

[s0rin]

Does sdoc generate documentation for js files within a rails project? (for ex. for app/assets/javascripts/home/settings.js). I found no reference about this so far.

There is an abandoned project https://github.com/breakpointer/ajax-rdoc developed for this purpose, it works with Rails 2.1.0 and no updates since 10 years.

[s0rin]

JavaScript documentation can be generated for ex. with JSDoc [1] which is a separate installation and a different usage, but how to document the *.js.erb files then?

[1] https://github.com/jsdoc3/jsdoc

[zzak]

@s0rin sdoc only generates documentation via rdoc, and that only supports a few types of files, such as:

RDoc::Parser::C
RDoc::Parser::ChangeLog
RDoc::Parser::Markdown
RDoc::Parser::RD
RDoc::Parser::Ruby
RDoc::Parser::RubyTools
RDoc::Parser::Simple
RDoc::Parser::Text

It would be interesting (although maybe out of scope for this project) if there was a way to combine documentation generators for Ruby and JavaScript / TypeScript for projects using both.