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

@example warp the decorator does NOT work #1016

Closed
imcuttle opened this issue Feb 19, 2018 · 4 comments
Closed

@example warp the decorator does NOT work #1016

imcuttle opened this issue Feb 19, 2018 · 4 comments

Comments

@imcuttle
Copy link

documentation fork doctrine named doctrine-temporary-fork to parse jsdoc

What JSDoc comment were you trying to parse?

/**
 * @example
 *  class Model extends Root {
 *      @urlSync
 *      @observable sync = 'abc'
 *  }
 * @public
 */
function urlSync () {...}

What happened? Include output if possible.

  • output
[ { title: 'example', description: 'class Model extends Root {' } ]

What did you expect to happen?

  • output
[ { title: 'example', description: 'class Model extends Root { \n  @urlSync .... }' } ]
@imcuttle
Copy link
Author

I could fix it by PR, but firstly, doctrine-temporary-fork repo is not be found.

@tmcw
Copy link
Member

tmcw commented Feb 19, 2018

doctrine-temporary-fork is over at documentation/doctrine

@imcuttle
Copy link
Author

Well, PR is here

@tmcw
Copy link
Member

tmcw commented Apr 11, 2018

PR merged, updating to the new release of tempfork now.

tmcw added a commit that referenced this issue Apr 11, 2018
Support decorators is an unspecified part of JSDoc: we're just going forward and implementing a new
syntax here because it's unlikely that JSDoc will move fast enough.

Fixes #1016
tmcw added a commit that referenced this issue Apr 11, 2018
Support decorators is an unspecified part of JSDoc: we're just going forward and implementing a new
syntax here because it's unlikely that JSDoc will move fast enough.

Fixes #1016
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

No branches or pull requests

2 participants