search

inch-ci / inch_ci-web

Web frontend for Inch CI
http://inch-ci.org/
MIT License
139 stars 20 forks source link

Update add_my_project_to_inch_ci.yml #44

Open ghost opened 9 years ago

ghost commented 9 years ago

So, actually eventric is a coffee-script project, but there is compiled javascript source available. Does this work too? Thanks for you efforts!

rrrene commented 9 years ago

Compiled JS is absolutely fine. The whole idea behind my little "call to action" is to get in contact with a diverse range of JS sources, so this is perfect.

Will try to make it work over the weekend!

rrrene commented 9 years ago

Hi there, sorry for keeping you waiting (I caught a nasty cold and wasn't really up to the task until now).

Funny thing: I tried running InchJS on the compiled source and the parser I intended to use (JSDoc) seems to misinterpret the @module and @name tags, which leads to this output where each code object is named like the module it is in:

$ inchjs list

# Seems really good

┃  A  ↓  module:Repository     in /build/src/repository/repository.js
┃  A  ↓  module:Repository     in /build/src/repository/repository.js
┃  A  ↓  module:Repository     in /build/src/repository/repository.js
┃  A  ↓  module:Repository     in /build/src/repository/repository.js
┃  A  ↓  module:Repository     in /build/src/repository/repository.js
[ ... snip ... ]

May I ask what you currently use to generate docs from the source?

ghost commented 9 years ago

Hey, thanks for looking into it! We're currently using dgeni which allows to define custom JSDoc tags and work with them. Let me know if I can provide more informations.