Opened 8 years ago

Closed 7 years ago

#14434 closed enhancement (fixed)

add better deprecated() support to doc parser

Reported by: dante Owned by: dante
Priority: high Milestone: 1.8
Component: Doc parser Version: 1.7.0
Keywords: Cc: Tom Trenka
Blocked By: Blocking:

Description

currently the doc parser output includes a "deprecated:true" value for member functions of a class, or in the body of any function.

it is possible to extract the details from this deprecated() call and could easily be reflected in the API output. A call to:

dojo.deprecated("Button.setLabel", "Button.set('label', label)", "2.0")

Could provide extended information regarding when the removal will take place, and provide hinttext for a replacement.

Additionally, whole deprecated modules are ignored completely. We should add detection of a deprecated module (usually just a require() that require()'s because of usage changes or filename changes)

Question: for ease of consumption into current API tools and possible existing usages of generated output, should $vardeprecated? = TRUE remain, and add $vardeprecated_details? = $info ... or will a truthy $vardeprecated? suffice (technically backwards incompatible change in doc parser)

Change History (2)

comment:1 Changed 8 years ago by bill

Many years ago, Neil claimed it already did this. Don't know if that's really true or not.

comment:2 Changed 7 years ago by Colin Snover

Resolution: fixed
Status: newclosed

New parser finds and reports these.

Note: See TracTickets for help on using tickets.