Skip to content

parse coffee comment syntax #56

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

Merged
merged 1 commit into from
Aug 9, 2012
Merged

parse coffee comment syntax #56

merged 1 commit into from
Aug 9, 2012

Conversation

hokaccha
Copy link
Contributor

@hokaccha hokaccha commented Aug 6, 2012

Add CoffeeScript comment syntax support.

set options --syntaxtype coffee.

$ yuidoc --syntaxtype coffee -e .coffee input

CoffeeScript code is this.

###*
# The test project
# @project tester
# @title The Tester
# @icon http://a.img
# @url http://one.url
# @url http://two.url
# @author admo
# @contributor davglass
# @contributor entropy
###

@travisbot
Copy link

This pull request passes (merged 36fa2df into c81f2dc).

@davglass
Copy link
Member

davglass commented Aug 6, 2012

@hokaccha Thanks for the Pull Request! In order for me to accept this change, I need you to sign the YUI CLA to prove that these changes are yours:

http://yuilibrary.com/contribute/cla/

Thanks

@ghost ghost assigned davglass Aug 6, 2012
@hokaccha
Copy link
Contributor Author

hokaccha commented Aug 7, 2012

@davglass I signed YUI CLA. yuilibrary.com username is 'hokaccha'.

Thank you.

@davglass
Copy link
Member

davglass commented Aug 7, 2012

Thanks, as soon as it's approved I'll merge this in.

@davglass davglass merged commit 36fa2df into yui:master Aug 9, 2012
@davglass
Copy link
Member

davglass commented Aug 9, 2012

This is in release 0.3.19 that I just pushed up to npm. Thanks!

@esamattis
Copy link

Why not just detect the syntaxtype by file extension? Currently it seems impossible to support multilang projects.

@artsyca
Copy link
Contributor

artsyca commented Sep 11, 2013

HI! I have a question about this syntax, and it's related to the 'DocBlockr' plugin for Sublime Text 3. (I'm asking a parallel question on their side.

AS it stands, this plugin outputs comments of this form:

###*
 * @method methodName
 * @param {String} foo Argument 1
 * @param {Object} config A config object
 * @param {String} config.name The name on the config object
 * @param {Function} config.callback A callback function on the config object
 * @param {Boolean} [extra=false] Do extra, optional work
 * @return {Boolean} Returns true on success
###

Which throw the dreaded warn: (docparser): Missing item type error.

Changing them to

###*
# @method methodName
# @param {String} foo Argument 1
# ...
###

or

###*
@method methodName
@param {String} foo Argument 1
...
###

will work (but is quite inconvenient for users of this plugin)

Is there any way to make yuidoc accept the first format?
(As you can imagine, I'm asking if DocBlockr can output one of the other two formats!)

Your help in this matter is greatly appreciated!

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.

5 participants