gjtorikian / biscotto

UNMAINTAINED. CoffeeScript API documentation tool that uses TomDoc notation.
https://gjtorikian.github.io/biscotto/
MIT License
105 stars 18 forks source link

How to document Method Overloading ? #85

Open SusanthCom opened 9 years ago

SusanthCom commented 9 years ago

How to document Method Overloading ?

For example CODO is having @overload. This is a common pattern in .js & .coffee ( same method may determine the signature at run time, based on parameters or order it is received )

# This is a generic Store set method.
#
# @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
#   @return [Boolean] true when success
#
set: (args...) ->