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

Support @overload tag #19

Closed
netzpirat opened this issue Feb 20, 2012 · 0 comments
Closed

Support @overload tag #19

netzpirat opened this issue Feb 20, 2012 · 0 comments
Labels

Comments

@netzpirat
Copy link
Contributor

Describe that your method can be used in various contexts with various parameters or return types. The first line should declare the new method signature, and the following indented tag data will be a new documentation string with its own tags adding metadata for such an overload.

class Store
  # @overload set(key, value)
  #   Sets a value on key
  #   @param [Symbol] key describe key param
  #   @param [Object] value describe value param
  # @overload set(value)
  #   Sets a value on the default key `:foo`
  #   @param [Object] value describe value param
  set: (args...) ->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant