Opened 12 years ago

Closed 12 years ago

Last modified 12 years ago

#4635 closed defect (wontfix)

summaries inside dojo.declare not being parsed by doctool

Reported by: dante Owned by: Neil Roberts
Priority: high Milestone: 1.0
Component: Doc parser Version: 0.9
Keywords: doctool Cc:
Blocked By: Blocking:

Description

eg: line 300~ dijit/Dialog.js

{{{ dojo.declare(

... { title: String Description of tooltip dialog (required for a11Y) title: "",

...

}}}

http://redesign.dojotoolkit.org/?q=jsdoc/dijit/HEAD/object/dijit.Dialog/dijit.TooltipDialog

shows the summary and type of the "title" attribute to be null

(as does _browse.php for Dialog.js)

affects all inline docs about parameters inside of dojo.declare()'s, maybe others.

Change History (6)

comment:1 Changed 12 years ago by Neil Roberts

Resolution: invalid
Status: newclosed

This is the proper behavior. A while back, it was decided that a comment block with a completely blank line discontinues the comment block. This allowed people to have both the comment block, and comments preceeding the code below it without conflict. Either add a "" to the blank line, or remove the blank line.

comment:2 Changed 12 years ago by dante

Resolution: invalid
Status: closedreopened

regarding the above example, it is _supposed_ to be two separate comment blocks. one for the summary, one for the title. it currently has no known info about the title attribute. see ~line 300, dijit/Dialog.js

// summary:
// 	 I am text that is being understood

 {this newline separates the "header" from the "attributes" blocks}
// title: String
// 	 I am supposed to be the summary for the title attribute with typeof string
title: "fooBar"

comment:3 Changed 12 years ago by Neil Roberts

(In [10767]) Refs #4635. Remove erroneous linebreak so that doc parsing works

comment:4 Changed 12 years ago by Neil Roberts

Resolution: wontfix
Status: reopenedclosed

dante: A new comment block is started when a line begins with a keyword, nothing more. A completely blank line discontinues all parsing.

comment:5 Changed 12 years ago by Neil Roberts

(In [10772]) Refs #4635. Update formatting before checking in fix

comment:6 Changed 12 years ago by Neil Roberts

(In [10773]) Refs #4635. Use trim instead of empty, and start block on false

Note: See TracTickets for help on using tickets.