Opened 14 years ago
Closed 14 years ago
#1472 closed enhancement (worksforme)
API doc generator -- allow description of return values
Reported by: | skinner | Owned by: | Neil Roberts |
---|---|---|---|
Priority: | lowest | Milestone: | 0.9 |
Component: | Doc parser | Version: | 0.3 |
Keywords: | Cc: | [email protected]… | |
Blocked By: | Blocking: |
Description
I've been reading the Code Documentation wiki page:
If I understand correctly, it's possible to associate a short description with each parameter, like this:
dojo.foo.go = function(/* int */ direction) { // Summary: Goes forward or back. // direction: int Use 1 for forward or -1 for backward }
It would be great to also add short descriptions about return values too, beyond just the type of the value, like this:
dojo.foo.getHeight = function() { return height; // float Always a value between 0 and maxHeight }
Change History (3)
comment:1 Changed 14 years ago by
Milestone: | → 0.5 |
---|
comment:2 Changed 14 years ago by
Owner: | changed from neil to Neil Roberts |
---|
comment:3 Changed 14 years ago by
Resolution: | → worksforme |
---|---|
Status: | new → closed |
Note: See
TracTickets for help on using
tickets.
This already works with the returns keyword in the initial comment block.