Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update add_my_project_to_inch_ci.yml #44

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update add_my_project_to_inch_ci.yml #44

wants to merge 1 commit into from

Conversation

ghost
Copy link

@ghost ghost commented Jan 24, 2015

No description provided.

@ghost
Copy link
Author

ghost commented Jan 24, 2015

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

@rrrene
Copy link
Contributor

rrrene commented Jan 24, 2015

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
Copy link
Contributor

rrrene commented Jan 28, 2015

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
Copy link
Author

ghost commented Jan 29, 2015

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant