Opened 13 years ago

Closed 13 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: skinner@…
Blocked By: Blocking:

Description

I've been reading the Code Documentation wiki page:

http://dojo.jot.com/Code%20Documentation

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 13 years ago by dylan

Milestone: 0.5

comment:2 Changed 13 years ago by bill

Owner: changed from neil to Neil Roberts

comment:3 Changed 13 years ago by Neil Roberts

Resolution: worksforme
Status: newclosed

This already works with the returns keyword in the initial comment block.

Note: See TracTickets for help on using tickets.