Opened 10 years ago

Closed 9 years ago

Last modified 9 years ago

#10540 closed defect (fixed)

dijit.popup API docs missing

Reported by: Adam Peller Owned by: Neil Roberts
Priority: high Milestone: 1.4.2
Component: Doc parser Version: 1.4.0
Keywords: Cc: Tom Trenka
Blocked By: Blocking:

Description

api.dtk shows methods like open/close/prepare missing from both 1.3.2 and HEAD. Tom's staging area shows these methods for 1.3, but not for 1.4.

Change History (4)

comment:1 Changed 10 years ago by Adam Peller

(In [21380]) move pseudo docs to top-level to make docparser run again. Refs #8606. Possibly refs #10540

comment:2 Changed 9 years ago by bill

I just ran php generate.php dijit and I see open/close/etc. in the cache/api.xml file, so this ticket can be closed, after opening a new ticket (marked for future?) about the doc parser bug itself.

comment:3 Changed 9 years ago by bill

Resolution: fixed
Status: newclosed

The problem was occuring when dijit.popup.OpenArgs was declared inside of dijit.popup... I'm not sure if that's supposed to be supported or not, so I don't want to file a ticket against the doc parser, but someone else can if they want. I'll close this ticket though since api.xml is now being generated correctly, thanks to Adam's change.

comment:4 Changed 9 years ago by Tom Trenka

As far as I know, you can't define pseudo-objects inside other declarations and have the doc parser pick them up; Neil never wrote it that way and it does seem to be kind of counter-intuitive.

However, it's good to know that this was the reason for the doc parser not picking up the declaration. Perhaps we should use the Trac wiki to include some sort of "tricks and tips" for docs?

Note: See TracTickets for help on using tickets.