Opened 16 years ago
Closed 15 years ago
#1474 closed enhancement (fixed)
API doc generator -- permit 'exceptions' as well as 'summary' and 'description'
Reported by: | skinner | Owned by: | Neil Roberts |
---|---|---|---|
Priority: | lowest | Milestone: | 1.0 |
Component: | Doc parser | Version: | 0.3 |
Keywords: | Cc: | [email protected]… | |
Blocked By: | Blocking: |
Description
I've been reading the Code Documentation wiki page:
That page says that in the comment block for a function, the API doc generator will look for a 'summary' section and a 'description' section.
It'd be great if the doc generator also recognized something like 'throws' or 'exceptions' as a keyword in the example block. For example:
dojo.foo.squareRoot = function(/* int */ value) { // Summary: Returns the square root of a value // Throws: Throws a RangeError if value is negative }
Change History (4)
comment:1 Changed 16 years ago by
Owner: | changed from neil to Neil Roberts |
---|
comment:2 Changed 16 years ago by
Milestone: | → 0.5 |
---|
comment:3 Changed 15 years ago by
fix attached to #1473
parser is picking out examples: and exceptions: now, but generate.php dies when I try to run it (did before patch though, too), so that still needs to be addressed.
Note: See
TracTickets for help on using
tickets.
Apparently you got confused between the two Neils.