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.

Sign up for GitHub

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

Jump to bottom

Add a @yields tag #1388

Closed
hegemonic opened this issue Jul 9, 2017 · 1 comment
Closed

Add a @yields tag #1388

hegemonic opened this issue Jul 9, 2017 · 1 comment
Labels
feature
Milestone
3.5.0

Comments

@hegemonic
Copy link
Contributor

hegemonic commented Jul 9, 2017 •
edited

We should add a @yields tag (synonym: @yield) to document the value provided by a generator function. We'll need to update the default template to support this new tag.
@hegemonic hegemonic added this to the 3.5.0 milestone Jul 9, 2017
hegemonic added a commit to jsdoc/jsdoc.github.io that referenced this issue Jul 9, 2017
@hegemonic
document generator tag
165a087 
The example uses the currently nonexistent yields tag, which will be added in jsdoc/jsdoc#1388.
hegemonic added a commit that referenced this issue Jul 9, 2017
@hegemonic
add yields tag (#1388)
c50a4c0
@hegemonic
Copy link
Contributor Author

Fixed on master. The fix will be included in JSDoc 3.5.0.

lheberlie added a commit to bsvensson/jsdoc that referenced this issue Aug 15, 2017
@lheberlie
Merge tag '3.5.0' into esrijs-sdk-3.5.4
c33c1b2 
3.5.0

* tag '3.5.0': (97 commits)
  3.5.0
  bump revision; start 3.6.0-dev
  update 3.5.0 changelog
  3.5.0 changelog
  reformat changelog
  add yields tag (jsdoc#1388)
  resolve the path to the JS config file before requiring it (jsdoc#1386)
  support namespaces that are also functions (jsdoc#955)
  add hideconstructor tag (jsdoc#952)
  add package tag (jsdoc#962)
  autodetect default and repeatable parameters when a function is assigned to a variable (jsdoc#1054)
  correctly document constructors and instance properties of ES2015 classes (jsdoc#1182)
  add sourceType config option
  fix crash when the author tag is empty (jsdoc#1289)
  add recurseDepth config option (jsdoc#1340)
  support bigint
  support import.meta
  support optional chaining
  support numeric separators
  support dynamic import
  ...

# Conflicts:
#	.eslintrc
#	README.md
#	lib/jsdoc/fs.js
#	lib/jsdoc/opts/args.js
#	lib/jsdoc/src/astbuilder.js
#	lib/jsdoc/src/astnode.js
#	lib/jsdoc/src/handlers.js
#	lib/jsdoc/src/parser.js
#	lib/jsdoc/src/visitor.js
#	lib/jsdoc/src/walker.js
#	lib/jsdoc/tag/dictionary/definitions.js
#	lib/jsdoc/tag/validator.js
#	lib/jsdoc/util/markdown.js
#	lib/jsdoc/util/templateHelper.js
#	package.json
#	templates/default/static/styles/jsdoc-default.css
#	templates/haruki/publish.js
#	test/spec-collection.js
#	test/specs/documentation/defaultparams.js
#	test/specs/documentation/restparams.js
#	test/specs/jsdoc/src/astnode.js
#	test/specs/jsdoc/util/templateHelper.js
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
feature
Projects
None yet
Milestone
3.5.0
Development

No branches or pull requests
1 participant
@hegemonic