marijnh / getdocs

Getdocs is not JSDoc
MIT License
145 stars 11 forks source link

Support documentation for parameters and returns #5

Closed angelozerr closed 8 years ago

angelozerr commented 8 years ago

It should be cool if we could add documentation for parameters and returns fucntion. An idea:

// :: (number{doc for arg0}, number{doc for arg1}) → number{doc for returns}
// Add two numbers
export function plus(a, b = 2) {
  return a + b
}

ternjs has the same issue https://github.com/ternjs/tern/issues/691

marijnh commented 8 years ago

Nope, I am intentionally not including this feature. I think the format of a simple signature plus a number of paragraphs that document the function and its parameters works well.