#13101 closed feature (fixed)
AMD doc parser
Reported by: | dante | Owned by: | Colin Snover |
---|---|---|---|
Priority: | high | Milestone: | 1.8 |
Component: | Doc parser | Version: | 1.6.1 |
Keywords: | Cc: | ||
Blocked By: | Blocking: |
Description
The doc parser is very confused about the new AMD modules. The format:
define(["dojo"], function(dojo){ return dojo; });
fails to "globalize" dojo
and pickup any internal references/docs ... There are a couple of solutions, unfortunately mostly further "unwrapping" the AMD into a format similar to the old 'standard' module pattern:
dojo.provide("dojo.foo"); dojo.require("dojo.bar"); (function(d){ /* code */ })(dojo);
need to implement this, and test files. need to make small adjustments to various modules to ensure docs are being properly parsed. this ticket will hold all commits relating to these fixes.
Ideally fixes will land only in the parser, but some modules will need reworking. Tracking all those changes. Hopefully they will be minimal and by tracking them all here we'll be able to see the patterns and apply them to the rest of the toolkit.
marking as blocker because I won't go to 1.7 until parsing is picking up a majority of the API inline docs.
Attachments (22)
Change History (335)
comment:1 Changed 10 years ago by
comment:2 Changed 10 years ago by
comment:3 Changed 10 years ago by
comment:4 Changed 10 years ago by
comment:5 Changed 10 years ago by
comment:6 Changed 10 years ago by
comment:7 Changed 10 years ago by
comment:9 Changed 10 years ago by
comment:10 Changed 10 years ago by
comment:12 Changed 10 years ago by
comment:13 Changed 10 years ago by
Changed 10 years ago by
Changed 10 years ago by
Changed 10 years ago by
Changed 10 years ago by
Attachment: | drawing.diff added |
---|
Changed 10 years ago by
Attachment: | encoding.diff added |
---|
Changed 10 years ago by
Changed 10 years ago by
Changed 10 years ago by
Changed 10 years ago by
Changed 10 years ago by
comment:15 Changed 10 years ago by
comment:16 Changed 10 years ago by
comment:17 Changed 10 years ago by
comment:20 Changed 10 years ago by
comment:24 Changed 10 years ago by
comment:26 Changed 10 years ago by
comment:30 Changed 10 years ago by
comment:35 Changed 10 years ago by
comment:36 Changed 10 years ago by
comment:37 Changed 10 years ago by
comment:38 Changed 10 years ago by
Adding svn diff of dojox/dnd for AMD conversion per conversation with @phiggins in IRC
comment:39 Changed 10 years ago by
comment:40 Changed 10 years ago by
comment:41 Changed 10 years ago by
comment:42 Changed 10 years ago by
comment:43 Changed 10 years ago by
comment:44 Changed 9 years ago by
comment:51 Changed 9 years ago by
Michael, I have committed most of your last batch in [28875]. I have not committed: ToggleSplitter, ScrollPane, RadioGroup and BusyButton because at least for some of them I think we can maybe do better. For example ScrollPane is a single class in a module. I don't see why it would require a false doc object?
comment:54 Changed 9 years ago by
Component: | General → Doc parser |
---|---|
Owner: | changed from dante to Colin Snover |
Status: | new → assigned |
comment:55 Changed 9 years ago by
Summary: | Beat the doc parser into understanding AMD → AMD doc parser |
---|
Changed 9 years ago by
Attachment: | mvcApiDocUpdates.patch added |
---|
For dojox/mvc API doc cleanup, mostly use MID's rather than (deprecated) global variables to indicate function parameter types and return value types.
Changed 9 years ago by
Attachment: | dojox_css3_api_doc.patch added |
---|
API doc cleanup for dojox/css3: fixes (e.g. use MIDs instead of dots) + doc additions (Adrian Vasiliu & Eric Durocher, IBM, CCLA)
Changed 9 years ago by
Attachment: | dojox_mobile_api_doc.patch added |
---|
API doc cleanup for dojox/mobile: fixes (e.g. use MIDs instead of dots) + doc additions (Adrian Vasiliu & Eric Durocher, IBM, CCLA)
comment:45 Changed 9 years ago by
Hello, please proxy commit the above patch for me, CCLA on file with IBM
Changed 9 years ago by
Attachment: | dojoxDataEditorFormLayoutWidget.patch added |
---|
more doc updates especially for editor plugs and layout. please proxy commit for Michael Billau (IBM, CCLA)
Changed 9 years ago by
Attachment: | dojoxDocPatchesLayoutFormData.patch added |
---|
rest of the doc fixes for dojox modules, please proxy commit for Michael Billau (IBM, CCLA).
comment:51 Changed 9 years ago by
Michael, I have committed most of your last batch in [28875]. I have not committed: ToggleSplitter, ScrollPane, RadioGroup and BusyButton because at least for some of them I think we can maybe do better. For example ScrollPane is a single class in a module. I don't see what it would require a false doc object?
Changed 9 years ago by
Attachment: | ScrollPaneToggleSplitterBusyButton.patch added |
---|
updated version of some dojox files, see comment 55, please commit for Michael Billau (IBM, CCLA)
Changed 9 years ago by
Attachment: | dojox_css3_api_doc_2.patch added |
---|
More dojox/css3 API doc fixes, mainly remove faux returns values and move doc inside returned object - Eric Durocher (IBM, CCLA)
Changed 9 years ago by
Attachment: | dojox_mobile_api_doc_further_fixes.patch added |
---|
Further API doc cleanup for dojox/mobile: fix doc of "_base" (was getting the doc of common); fix list formatting (needs empty doc line); fix escaping of HTML tag in "returns" section (here markdown doesn't hold); added some missing doc, including on ctors; added some missing arg/return types; a few rephrasings and formatting fixes. (Adrian Vasiliu, IBM, CCLA)
Changed 9 years ago by
Attachment: | dojox_all_list_formatting_patch_13101.patch added |
---|
Fixing the markdown for list formatting in dojox.*. Most often, introduced an empty comment line when the list is not at the beginning of a doc section. In other cases added dashes or replaced stars by dashes. (Adrian Vasiliu, IBM, CCLA)
Changed 9 years ago by
Attachment: | mobile_child_widget_props_api_doc.patch added |
---|
Document dojox/mobile "child widget properties" similar to bill's last changes in BorderContainer? etc. - Eric Durocher (IBM, CCLA)
comment:193 Changed 8 years ago by
Milestone: | 1.8 → 2.0 |
---|
1.8 has been tagged; moving all outstanding tickets to next major release milestone.
comment:194 Changed 8 years ago by
Milestone: | 2.0 → 1.8 |
---|---|
Resolution: | → fixed |
Status: | assigned → closed |
Type: | defect → feature |
We should just mark this as fixed. The remaining issues with the doc parser are filed as separate tickets in this bug database or github.
comment:216 Changed 6 years ago by
Partially backported to 1.7 in e7403082d02faba2e47cb645d2532dd2920f60b8.
(In [25245]) refs #13101 - update the parser to unwrap amd modules more. testing prefixed locals and raw original globals. renames _browse2.php to preview.php and adds hash support for direct linking to problematic files. adds a util module. adds basic unit tests. adds a single serve dumpObj.php pseudo-rpc-api to fetch all data for a single file (for unit tests)