Opened 10 years ago

Closed 10 years ago

#16228 closed enhancement (fixed)

Function summary does not appear in documentation

Reported by: adros Owned by: bill
Priority: undecided Milestone: 1.9
Component: Documentation Version: 1.8.1
Keywords: Cc:
Blocked By: Blocking:

Description

General function information contains section "description". But this section does not appear in API documentation.

E.g. dijit/_base/focus, contains: description: Currently only used by editor.

But this information could not be found in http://dojotoolkit.org/api/1.8/dijit/_base/focus

Change History (2)

comment:1 Changed 10 years ago by bill

Milestone: tbd → 1.9
Owner: set to bill
Status: new → assigned

That's odd. It does show up in details.xml, so not sure why the api-viewer isn't showing it. I'll take a look.

comment:2 Changed 10 years ago by bill

Resolution: → fixed
Status: assigned → closed

OK, fixed in ​https://github.com/wkeese/api-viewer/commit/4afc1c950c9b1f3dd44e519de54cc0b626b2f788 and ​https://github.com/wkeese/api-viewer/commit/e8bdfa88b60b625836d5155a6c5c093117730962. It's now showing both the summary and the description. Will be rolled out for the documentation for 1.9.

Note: See TracTickets for help on using tickets.