Opened 14 years ago
Closed 14 years ago
#4636 closed defect (fixed)
parse problem in doctool regarding function parameters
Reported by: | dante | Owned by: | Neil Roberts |
---|---|---|---|
Priority: | high | Milestone: | 1.0 |
Component: | Doc parser | Version: | 0.9 |
Keywords: | doctool | Cc: | Adam Peller |
Blocked By: | Blocking: |
Description
in _base/fx.js this code exists:
fire: function(/*Event*/ evt, /*Array?*/ args){ // summary: Convenience function. Fire event "evt" and pass it // the arguments specified in "args". // evt: The event to fire. // args: The arguments to pass to the event. if(this[evt]){ this[evt].apply(this, args||[]); } return this; // dojo._Animation },
the doc parser is picking up this [valid?] documenting syntax and striping the first word in leui of a param type:
eg, the above translates to:
function fire(/* The */evt, /* The */args); and the summaries for each param are missing the word "the"
adding:
evt: Event The event to fire
fixes, though is unreadable to humans, so marking as bug.
note this is unrelated to #4635 because [although] this is inside a dojo.declare (dojo._Animation), it is inside a specific method of the declared class.
Change History (6)
comment:1 Changed 14 years ago by
Cc: | Adam Peller added |
---|
comment:2 Changed 14 years ago by
Resolution: | → fixed |
---|---|
Status: | new → closed |
comment:3 Changed 14 years ago by
Resolution: | fixed |
---|---|
Status: | closed → reopened |
see _base/json.js
{{
function toJson(/*string*/foo){
foo: a string of something
} }}
comes up parameter foo typeof "a" with summary = "string of something"
reopening as per your request.
comment:4 Changed 14 years ago by
comment:5 Changed 14 years ago by
comment:6 Changed 14 years ago by
Resolution: | → fixed |
---|---|
Status: | reopened → closed |
(In [10765]) Fixes #4636. Don't just check for spaces, newlines are valid separators