Opened 10 years ago

Last modified 10 years ago

#15292 closed defect

[meta] modules not displaying in API docs — at Version 6

Reported by: haysmark Owned by: haysmark
Priority: high Milestone: 1.8
Component: Documentation Version: 1.7.2
Keywords: Cc: Colin Snover
Blocked By: Blocking:

Description (last modified by haysmark)

There are a few modules that are not listed in the api.xml or do not have their docs completely listed. For instance, it seems that the API parser is not happy about scripts like dijit/registry that define() an object without formally declare()ing it as well.

  • dijit.registry: does not show in list. preview shows no docs.
  • dijit._Widget and _WidgetBase: does not show in list, presumably because it is private, but is generated.
  • dijit.Dialog: the multiple inheritance seems to throw it off. looks fine in preview, but nothing shows in entry live.

Change History (6)

comment:1 Changed 10 years ago by haysmark

Milestone: tbd1.8
Owner: set to haysmark
Priority: undecidedhigh
Status: newassigned

comment:2 Changed 10 years ago by bill

But, Colin is completely rewriting the API parser. Or are you talking about the new parser? Theoretically dijit/registry will be fine with his new parser.

dijit/registry isn't using declare because it's not a "class", but rather just a bunch of related methods.

comment:3 Changed 10 years ago by haysmark

Resolution: fixed
Status: assignedclosed

In [28485]:

Add doc comments to dijit/registry.js so it appears in api.xml. Fixes #15292.

comment:4 Changed 10 years ago by haysmark

Resolution: fixed
Status: closedreopened

Oops meant Refs, not fixes.

comment:5 Changed 10 years ago by haysmark

Description: modified (diff)

comment:6 Changed 10 years ago by haysmark

Description: modified (diff)
Note: See TracTickets for help on using tickets.