Opened 13 years ago

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

Description

I've been reading the Code Documentation wiki page:

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

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

Owner: changed from neil to Neil Roberts

Apparently you got confused between the two Neils.

comment:2 Changed 13 years ago by dylan

Milestone: 0.5

comment:3 Changed 12 years ago by dante

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.

comment:4 Changed 12 years ago by dante

Resolution: fixed
Status: newclosed

(In [10650]) fixes #1474 - you can put exceptions: (comment) inline doc, and the tool picks it up fixes #1473 - allows examples: (comment) to be picked up by parser refs #4591 - lots of style cleanups to parser php files

Note: See TracTickets for help on using tickets.