Opened 8 years ago

Closed 7 years ago

Last modified 5 years ago

#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)

calc.diff (389 bytes) - added by dante 8 years ago.
data.diff (4.5 KB) - added by dante 8 years ago.
date.diff (68.0 KB) - added by dante 8 years ago.
drawing.diff (8.8 KB) - added by dante 8 years ago.
encoding.diff (33.0 KB) - added by dante 8 years ago.
form.diff (769 bytes) - added by dante 8 years ago.
grid.diff (17.8 KB) - added by dante 8 years ago.
math.diff (8.6 KB) - added by dante 8 years ago.
mvc.diff (3.5 KB) - added by dante 8 years ago.
rpc.diff (1.1 KB) - added by dante 8 years ago.
dojoxdnd.diff (40.9 KB) - added by oshea.ie 8 years ago.
dojox-dnd diff for AMD
dojoxdnd.2.diff (33.4 KB) - added by oshea.ie 8 years ago.
New dojoxdnd diff
mvcApiDocUpdates.patch (89.1 KB) - added by Ed Chatelain 7 years ago.
For dojox/mvc API doc cleanup, mostly use MID's rather than (deprecated) global variables to indicate function parameter types and return value types.
dojox_css3_api_doc.patch (9.0 KB) - added by Eric Durocher 7 years ago.
API doc cleanup for dojox/css3: fixes (e.g. use MIDs instead of dots) + doc additions (Adrian Vasiliu & Eric Durocher, IBM, CCLA)
dojox_mobile_api_doc.patch (213.0 KB) - added by Eric Durocher 7 years ago.
API doc cleanup for dojox/mobile: fixes (e.g. use MIDs instead of dots) + doc additions (Adrian Vasiliu & Eric Durocher, IBM, CCLA)
dojoxDataEditorFormLayoutWidget.patch (103.8 KB) - added by mikeb 7 years ago.
more doc updates especially for editor plugs and layout. please proxy commit for Michael Billau (IBM, CCLA)
dojoxDocPatchesLayoutFormData.patch (46.9 KB) - added by mikeb 7 years ago.
rest of the doc fixes for dojox modules, please proxy commit for Michael Billau (IBM, CCLA).
ScrollPaneToggleSplitterBusyButton.patch (5.2 KB) - added by mikeb 7 years ago.
updated version of some dojox files, see comment 55, please commit for Michael Billau (IBM, CCLA)
dojox_css3_api_doc_2.patch (4.0 KB) - added by Eric Durocher 7 years ago.
More dojox/css3 API doc fixes, mainly remove faux returns values and move doc inside returned object - Eric Durocher (IBM, CCLA)
dojox_mobile_api_doc_further_fixes.patch (15.5 KB) - added by Adrian Vasiliu 7 years ago.
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)
dojox_all_list_formatting_patch_13101.patch (54.6 KB) - added by Adrian Vasiliu 7 years ago.
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)
mobile_child_widget_props_api_doc.patch (4.9 KB) - added by Eric Durocher 7 years ago.
Document dojox/mobile "child widget properties" similar to bill's last changes in BorderContainer? etc. - Eric Durocher (IBM, CCLA)

Download all attachments as: .zip

Change History (335)

comment:1 Changed 8 years ago by dante

(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)

comment:2 Changed 8 years ago by dante

(In [25246]) refs #13101 - minor changes to dojo modules to ensure maximum accurate api information is parsed out \!strict

comment:3 Changed 8 years ago by dante

(In [25247]) refs #13101 - not that these get parsed, but is part of a s/r for colonlesssummary blocks

comment:4 Changed 8 years ago by dante

(In [25248]) refs #13101 - whitespace and colonlesssummary changes in dijit

comment:5 Changed 8 years ago by dante

(In [25249]) refs #13101 - summarycolon and whitespace in dojo \!strict

comment:6 Changed 8 years ago by dante

(In [25258]) refs #13101 - makes preview not use excla for sep. use full path instead.

comment:7 Changed 8 years ago by dante

(In [25321]) better debugging in preview, hash better, etc. refs #13101

comment:8 Changed 8 years ago by dante

(In [25322]) inline doc fixes refs #13101 \!strict

comment:9 Changed 8 years ago by bill

(In [25323]) Fixing API doc for new dijit modules, refs #13101 !strict.

comment:10 Changed 8 years ago by dante

(In [25324]) refs #13101 - make aspect.js exposed as dojo.aspect \!strict

comment:11 Changed 8 years ago by dante

(In [25325]) refs #13101 - expose dojo.back docs again.

comment:12 Changed 8 years ago by bill

(In [25327]) removing d --> dojo aliases, plus an unneeded closure, refs #13101 !strict.

comment:13 Changed 8 years ago by dante

(In [25344]) removing unneeded iffe's and some whitespace for doc reasons, refs #13101 \!strict

Changed 8 years ago by dante

Attachment: calc.diff added

Changed 8 years ago by dante

Attachment: data.diff added

Changed 8 years ago by dante

Attachment: date.diff added

Changed 8 years ago by dante

Attachment: drawing.diff added

Changed 8 years ago by dante

Attachment: encoding.diff added

Changed 8 years ago by dante

Attachment: form.diff added

Changed 8 years ago by dante

Attachment: grid.diff added

Changed 8 years ago by dante

Attachment: math.diff added

Changed 8 years ago by dante

Attachment: mvc.diff added

Changed 8 years ago by dante

Attachment: rpc.diff added

comment:14 Changed 8 years ago by dante

(In [25352]) refs #13101 - removing unnecessary iife

comment:15 Changed 8 years ago by dante

(In [25353]) refs #13101 - removing unnecessary iife (doing nuclear commits in case something is wrong in one of the namesapces

comment:16 Changed 8 years ago by dante

(In [25354]) refs #13101 - removing unnecessary iife and small whitespace changes \!strict

comment:17 Changed 8 years ago by dante

(In [25355]) refs #13101 - removing unnecessary iife and space->tab conversion \!strict

comment:18 Changed 8 years ago by dante

(In [25356]) refs #13101 - removing unnecessary iife

comment:19 Changed 8 years ago by dante

(In [25357]) refs #13101 - removing unnecessary iife

comment:20 Changed 8 years ago by dante

(In [25358]) refs #13101 - removing unnecessary iife and whitespaces

comment:21 Changed 8 years ago by dante

(In [25359]) refs #13101 - removing unnecessary iife

comment:22 Changed 8 years ago by dante

(In [25360]) refs #13101 - removing unnecessary iife

comment:23 Changed 8 years ago by dante

(In [25361]) refs #13101 - removing unnecessary iife \!strict

comment:24 Changed 8 years ago by dante

(In [25362]) refs #13101 - whitespace randomly found while debugging \!strict

comment:25 Changed 8 years ago by dante

(In [25363]) simple cleanups in preview css refs #13101

comment:26 Changed 8 years ago by dante

(In [25364]) refs #13101 - update some dojox.widget stuff to amd and make parser find more stuff

comment:27 Changed 8 years ago by dante

(In [25365]) refs #13101 - fisheyelite to amd

comment:28 Changed 8 years ago by dante

(In [25367]) refs #13101 - titlegroup -> amd \!strict

comment:29 Changed 8 years ago by dante

(In [25368]) update widget/Toaster to be amd refs #13101

comment:30 Changed 8 years ago by bill

(In [25369]) Define dijit.BackgroundIframe in BackgroundIframe.js, so it shows up better in the API doc. Also adding explicit requires for wherever this module is used. Refs #13101 !strict.

comment:31 Changed 8 years ago by dante

(In [25388]) refs #13101 - dojox.image -> amd \!strict

comment:32 Changed 8 years ago by dante

(In [25389]) refs #13101 - use dojo/text for template

comment:33 Changed 8 years ago by dante

(In [25393]) refs #13101 - extended doc for dojox.validate

comment:34 Changed 8 years ago by dante

(In [25394]) refs #13101 - return image, add module level doc

comment:35 Changed 8 years ago by dante

(In [25398]) refs #13101 - makes dojo.query docs show up in api tool \!strict ironically

comment:36 Changed 8 years ago by dante

(In [25429]) refs #13101 - getting rid of FIXME's that end up in api docs, mostly. \!strict

comment:37 Changed 8 years ago by dante

(In [25430]) refs #13101 - dijit version of cleaning FIXME's in api parse \!strict (lots of warnings)

Changed 8 years ago by oshea.ie

Attachment: dojoxdnd.diff added

dojox-dnd diff for AMD

comment:38 Changed 8 years ago by oshea.ie

Adding svn diff of dojox/dnd for AMD conversion per conversation with @phiggins in IRC

Changed 8 years ago by oshea.ie

Attachment: dojoxdnd.2.diff added

New dojoxdnd diff

comment:39 Changed 8 years ago by dante

(In [25469]) refs #13101 - style, docs, and note changes \!strict from dojo.js

comment:40 Changed 8 years ago by bill

(In [25504]) Add ability to specify themes in a different directory (fixes #13226, thanks Eldon), plus fixing typo from [25327] (refs #13101).

comment:41 Changed 8 years ago by Eugene Lazutkin

(In [25660]) dnd: converted to AMD, added more tests, thx oshea.ie!, !strict, refs #13101.

comment:42 Changed 8 years ago by dante

(In [25782]) refs #13101 - more doc parser abuse. and whitespace \!strict

comment:43 Changed 8 years ago by Bryan Forbes

(In [25788]) Doc parser fixes for AdapterRegistry. refs #13101 !strict

comment:44 Changed 8 years ago by bill

(In [25947]) Thanks to [25893] the "lang = dojo.lang" workaround is no longer needed to make the API doc work. Refs #13101 !strict.

comment:45 Changed 8 years ago by bill

In [26087]:

Fix TitleGroup missing dependencies, test file duplicate declaration, etc. Refs #13101 !strict.

comment:46 Changed 8 years ago by bill

In [26088]:

Fix Toaster missing dependency, refs #13101 !strict.

comment:47 Changed 8 years ago by Douglas Hays

please investigate if dumpObj.php needs htmlspecialchars added

comment:48 Changed 8 years ago by bill

In [26257]:

var lang = dojo hint to doc parser no longer necessary, refs #13101 !strict

comment:49 Changed 8 years ago by nic

In [26363]:

Doc parser fixes, refs #13101

comment:50 Changed 8 years ago by bill

In [26963]:

Fix API doc for dojo/fx/easing (on trunk), and remove global dojo reference, refs #13101 !strict.

comment:51 Changed 8 years ago by bill

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?

Last edited 7 years ago by cjolif (previous) (diff)

comment:52 Changed 7 years ago by dante

In [27354]:

refs #13101 - find dojox/html/styles api

comment:53 Changed 7 years ago by Douglas Hays

In [27737]:

Refs #13101. Remove 0 length test file. The original test file had 2 failures.

comment:54 Changed 7 years ago by bill

Component: GeneralDoc parser
Owner: changed from dante to Colin Snover
Status: newassigned

Might as well use this ticket to track the new doc parser. (Or if you prefer, close this one and open a new ticket.) See also #14980 and the essentially duplicate #15292.

Last edited 7 years ago by bill (previous) (diff)

comment:55 Changed 7 years ago by bill

Summary: Beat the doc parser into understanding AMDAMD doc parser

comment:56 Changed 7 years ago by Colin Snover

In [28582]:

Refs #13101. Error in doc-code block.

comment:57 Changed 7 years ago by bill

In [28585]:

Document module exports rather than dojo globals, ie: array.forEach(), not dojo.forEach(). Refs #13101 !strict.

comment:58 Changed 7 years ago by Colin Snover

In [28593]:

Refs #13101. Remove invalid superfluous comment from dojo/keys.

comment:59 Changed 7 years ago by bill

In [28594]:

Not sure if declare() requires a hash argument or not, but it confuses the doc parser if it isn't there. Refs #13101 !strict.

comment:60 Changed 7 years ago by Colin Snover

In [28595]:

Refs #13101. Remove commented code being misinterpreted as part of the docblock.

!strict due to other existing invalid code.

comment:61 Changed 7 years ago by Colin Snover

In [28596]:

Refs #13101. Separate code comment from docblock.

comment:62 Changed 7 years ago by Colin Snover

In [28597]:

Refs #13101. Fix various dojodoc comment errors and other issues with comments that prevent correct parsing.

!strict due to existing invalid code.

comment:63 Changed 7 years ago by Colin Snover

In [28598]:

Refs #13101. Fix more comment errors.

!strict due to existing invalid code.

comment:64 Changed 7 years ago by bill

In [28602]:

dojo/_base/lang API doc cleanup:

  1. Document module exports rather than dojo globals, ie: lang.extend(), not dojo.extend().
  2. Inline methods into export hash, rather than using intermediate local variables.
  3. Replace dependency on dojo/_base/sniff with dependency on slimmer (and non-deprecated) dojo/sniff.


Refs #13101 !strict.

comment:65 Changed 7 years ago by bill

In [28603]:

dojo/_base/sniff API doc cleanup, refs #13101 !strict.

comment:66 Changed 7 years ago by bill

In [28605]:

Doc fixes. Not that this file is *only* used by the doc parser. Refs #13101 !strict

comment:67 Changed 7 years ago by bill

In [28606]:

a few more doc fixes, refs #13101 !strict

comment:68 Changed 7 years ago by Colin Snover

In [28610]:

Refs #13101. Fix more doc comment errors.

!strict due to existing invalid code.

comment:69 Changed 7 years ago by bill

In [28615]:

Minimizing references to dojo "global", refs #13101 tangentially, !strict

comment:70 Changed 7 years ago by Colin Snover

In [28617]:

Refs #13101. Fix the most egregious dojox doc errors.

!strict due to existing invalid code.

comment:71 Changed 7 years ago by Colin Snover

In [28618]:

Refs #13101. Try to fix up dojox/gfx docs.

!strict due to existing invalid code.

comment:72 Changed 7 years ago by Colin Snover

In [28636]:

Refs #13101. Fix bad example.

!strict due to existing invalid code.

comment:73 Changed 7 years ago by Colin Snover

In [28637]:

Refs #13101. Fix docblock indentation errors.

!strict due to existing invalid code.

comment:74 Changed 7 years ago by Colin Snover

In [28638]:

Refs #13101. Fix bad docblock tag.

comment:75 Changed 7 years ago by bill

In [28639]:

fix module name, refs #13101 !strict.

comment:76 Changed 7 years ago by bill

In [28641]:

Someday we may change the API of the parser to be called like new Parser({...}).parse(), but for now, there no reason to internally have a Parser "class" and a singleton of that class, rather than just a hash of functions.

Refs #13101 tangentially, !strict.

comment:77 Changed 7 years ago by Colin Snover

In [28642]:

Refs #13101. Fix incorrect currency docblocks.

comment:78 Changed 7 years ago by bill

In [28644]:

dojox/calc: fixing API doc errors and formatting, refs #13101, !strict.

comment:79 Changed 7 years ago by bill

In [28646]:

dojox/collections: fixing API doc errors and formatting, refs #13101 !strict.

comment:80 Changed 7 years ago by bill

In [28647]:

dojox/color: fixing API doc errors and formatting, refs #13101 !strict.

comment:81 Changed 7 years ago by bill

In [28649]:

dojox/encoding: fixing API doc errors and formatting, refs #13101 !strict.

comment:82 Changed 7 years ago by bill

In [28650]:

dojox/json: fixing API doc errors and formatting, refs #13101 !strict.

comment:83 Changed 7 years ago by bill

In [28651]:

fix AMD conversion and doc comments, refs #12863, #13101 !strict

comment:223 Changed 7 years ago by bill

In [28652]:

dojox/analytics: Fixing API doc errors and formatting. The event handling modules seem to have unneeded closures like (function(){...})(), but leaving them for now. Refs #13101 !strict.

comment:224 Changed 7 years ago by bill

In [28659]:

dojox/gfx3d: fix API doc comment formatting and content. object.js had a lot of comments that didn't make sense, because of cut/pasting. I tried to fix them, and remove the irrelevant ones. Refs #13101 !strict.

comment:225 Changed 7 years ago by bill

In [28661]:

fix indentation, refs #13101 !strict.

comment:226 Changed 7 years ago by bill

In [28662]:

a few api doc fixes, refs #13101 !strict.

comment:227 Changed 7 years ago by bill

In [28663]:

a few more commenting format fixes, refs #13101 !strict.

comment:228 Changed 7 years ago by bill

In [28664]:

dojox/cometd: api comment format fixes, refs #13101 !strict.

comment:229 Changed 7 years ago by bill

In [28665]:

dojox/html: api comment format fixes, refs #13101 !strict.

comment:230 Changed 7 years ago by Colin Snover

In [28669]:

Refs #13101. 1.x hack to create correct map between globals and dojo.dijit/dojox in the doc parser.

!strict due to existing invalid code.

comment:231 Changed 7 years ago by Colin Snover

In [28670]:

Refs #13101. Fix invalid docblocks.

!strict due to existing invalid code.

comment:232 Changed 7 years ago by Colin Snover

In [28673]:

Refs #13101. Fix invalid doc blocks.

!strict due to existing invalid code.

comment:233 Changed 7 years ago by bill

In [28674]:

add dependency comment, refs #13101 tangentially !strict

comment:234 Changed 7 years ago by bill

In [28677]:

dojox/form: api doc format fixes, refs #13101 !strict.

comment:235 Changed 7 years ago by Colin Snover

In [28682]:

Refs #13101. Split code comment from docblock.

!strict due to existing invalid code.

comment:236 Changed 7 years ago by bill

In [28686]:

dojox/charting: remove unnecessary doc parser hints, refs #13101 !strict.

comment:237 Changed 7 years ago by bill

In [28687]:

dojox/charting: fix API doc comment spacing and various syntax errors, refs #13101 !strict.

comment:238 Changed 7 years ago by bill

In [28688]:

dojox/charting: use declare() rather than dojo.declare() in doc comments, refs #13101 !strict.

comment:239 Changed 7 years ago by bill

In [28689]:

dojox/charting: fix a few more doc comments, refs #13101 !strict.

comment:240 Changed 7 years ago by bill

In [28692]:

dojox/data: lots of doc formatting fixes, and removing unneeded doc hints, refs #13101 !strict.

comment:241 Changed 7 years ago by bill

In [28696]:

dojox/data: more api doc and spacing fixes, and correct a few errors from previous checkin, refs #13101 !strict.

comment:242 Changed 7 years ago by bill

In [28697]:

Removing _module.js files which (despite their name) don't describe modules at all, but rather describe javascript namespaces (ex: dojo/dnd, dijit/layout, dojox/widget). These files don't really have a place in the AMD world, and that information is already in the reference guide and/or the package manifest files for packages registered in packages.dojofoundation.org.

Refs #13101

comment:243 Changed 7 years ago by bill

In [28721]:

dojox/date: fix api doc comments, refs #13101 !strict

comment:244 Changed 7 years ago by bill

#15292 is a duplicate of this ticket.

comment:245 Changed 7 years ago by bill

#7831 is a duplicate of this ticket.

comment:246 Changed 7 years ago by bill

In [28726]:

dojo/json: fix api doc comment spacing, refs #13101 !strict

comment:247 Changed 7 years ago by bill

In [28732]:

dojox/gfx: Big cleanup of API doc formatting, and finish conversion to AMD, plus some fixes for spelling and lint, refs #13101 !strict.

comment:248 Changed 7 years ago by bill

In [28733]:

dojox/gauges: removing unneeded doc parser hints, refs #13101 !strict.

comment:249 Changed 7 years ago by cjolif

In [28735]:

refs #13101. Get rid of dummy definition for doc parser to understand class inheritance. !strict.

comment:250 Changed 7 years ago by cjolif

In [28738]:

refs #13101. Improvment to API doc for new parser.

comment:251 Changed 7 years ago by cjolif

In [28754]:

refs #13101. Avoid the inlining problem by using / notation.

comment:252 Changed 7 years ago by cjolif

In [28758]:

refs #13101. Improve dojox/color doc for new parser. !strict.

comment:253 Changed 7 years ago by cjolif

In [28760]:

refs #13101. Improve treemap doc.

comment:254 Changed 7 years ago by cjolif

In [28761]:

refs #13101. Improve doc. !strict.

comment:255 Changed 7 years ago by Patrick Ruzand

In [28762]:

repair last commit (for back. compat), refs #13101 (more doc work will be done when doc parser issue 19 will be fixed) !strict

comment:256 Changed 7 years ago by Patrick Ruzand

In [28765]:

doc, refs #13101

comment:257 Changed 7 years ago by cjolif

In [28766]:

refs #13101. More doc fixes.

comment:258 Changed 7 years ago by cjolif

In [28767]:

refs #13101. More doc fixes.

comment:259 Changed 7 years ago by cjolif

In [28787]:

refs #13101. Improve charting API doc wrt new parser. !strict.

comment:260 Changed 7 years ago by Patrick Ruzand

In [28788]:

update doc for new parser, refs #13101 !strict

comment:261 Changed 7 years ago by bill

In [28790]:

For dojo and dijit, use MID's rather than (deprecated) global variables to indicate function parameter types and return value types.

Also created a dummy dojo/data/api/Item type for ease of documentation of modules still using the old dojo.data API.

Refs #13101 !strict.

comment:262 Changed 7 years ago by bill

In [28791]:

Miscellaneous API doc formatting fixes, refs #13101 !strict.

comment:263 Changed 7 years ago by cjolif

In [28792]:

refs #13101. Improve API doc. !strict.

comment:264 Changed 7 years ago by cjolif

In [28793]:

refs #13101. Fix doc issue in treemap.

comment:265 Changed 7 years ago by cjolif

In [28804]:

refs #13101. Fixes issue introduced while modifying code for API doc.

comment:266 Changed 7 years ago by bill

In [28809]:

dojox/grid: a few fixes for API doc comment formatting, refs #13101 !strict.

comment:267 Changed 7 years ago by bill

In [28810]:

dojox/geo: Fixing code to conform to Dojo coding standards: no spaces for if(), else, etc., braces for all if() and else statements, no spaces before colons, removing spaces at ends of lines, etc.

Also some more doc comment fixes, mainly removing duplicate type declarations for parameters


Refs #13036, #13101 !strict.

comment:35 Changed 7 years ago by bill

In [28811]:

dojox/io: do some api doc cleanup, although it doesn't seem like this code is working, refs #13101 !strict.

comment:36 Changed 7 years ago by bill

In [28813]:

Use just one question mark for optional parameters with multiple types, ex: /* String|Object? */ not /* String?|Object? */, refs #13101 !strict.

comment:37 Changed 7 years ago by Patrick Ruzand

In [28815]:

more api fixes for new parser, refs #13101 !strict

comment:38 Changed 7 years ago by Patrick Ruzand

In [28816]:

more api fixes for new parser, refs #13101 !strict

comment:39 Changed 7 years ago by bill

In [28819]:

remove unneeded doc parser hint, refs #13101 !strict

Changed 7 years ago by Ed Chatelain

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 7 years ago by Eric Durocher

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)

comment:40 Changed 7 years ago by cjolif

In [28823]:

refs #13101. dojox/mvc API doc cleanup, mostly use MID's rather than (deprecated) global variables to indicate function parameter types and return value types. Thanks Ed Chatelain (IBM, CCLA). !strict.

comment:41 Changed 7 years ago by Patrick Ruzand

In [28825]:

more api fixes for new parser, refs #13101 !strict

Changed 7 years ago by Eric Durocher

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:42 Changed 7 years ago by cjolif

In [28826]:

refs #13101. Fixes regression introduced by API doc patch. !strict.

comment:43 Changed 7 years ago by cjolif

In [28828]:

refs #13101. API doc cleanup for dojox/css3: fixes (e.g. use MIDs instead of dots) + doc additions (Adrian Vasiliu & Eric Durocher, IBM, CCLA). !strict.

comment:44 Changed 7 years ago by cjolif

In [28830]:

refs #13101. Add forgotten summary.

comment:45 Changed 7 years ago by mikeb

Hello, please proxy commit the above patch for me, CCLA on file with IBM

comment:46 Changed 7 years ago by cjolif

In [28833]:

refs #13101. Initial doc patches for some dojox packages. Thanks Michael Billau (IBM, CCLA). !strict.

Changed 7 years ago by mikeb

more doc updates especially for editor plugs and layout. please proxy commit for Michael Billau (IBM, CCLA)

comment:47 Changed 7 years ago by cjolif

In [28837]:

refs #13101. More doc patches for some dojox packages. Thanks Michael Billau (IBM, CCLA). !strict.

comment:48 Changed 7 years ago by bill

In [28840]:

various API doc fixes, refs #13101 !strict

comment:49 Changed 7 years ago by bill

In [28845]:

dojox/mvc: remove doc parser hint, refs #13101 !strict

comment:50 Changed 7 years ago by bill

In [28869]:

fix typo in api comment, refs #13101 !strict

Changed 7 years ago by mikeb

rest of the doc fixes for dojox modules, please proxy commit for Michael Billau (IBM, CCLA).

comment:51 Changed 7 years ago by cjolif

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?

comment:52 Changed 7 years ago by cjolif

In [28876]:

refs #13101. Fixes some problems in latest patch. !strict.

comment:53 Changed 7 years ago by Colin Snover

In [28877]:

Enhance dojo/store/JsonRest to allow headers to be provided:

  1. for all calls, not just GET calls;
  2. directly on the store that are sent automatically with all requests for that store.

Fixes #15406.

Also fixes some doc block whitespace issues, Refs #13101.

comment:54 Changed 7 years ago by bill

In [28883]:

dojox/dnd: fix api doc comments, refs #13101 !strict

comment:55 Changed 7 years ago by bill

In [28884]:

dojox/encoding: api doc comment cleanup, refs #13101 !strict

comment:56 Changed 7 years ago by bill

In [28885]:

dojox/highlight: api doc comment cleanup, refs #13101 !strict

comment:57 Changed 7 years ago by bill

In [28886]:

dojox/lang: api doc comment cleanup, refs #13101 !strict

comment:58 Changed 7 years ago by bill

In [28887]:

dojox/math: api doc comment cleanup, refs #13101 !strict

comment:59 Changed 7 years ago by bill

In [28888]:

dojox/validate: api doc comment cleanup, refs #13101 !strict

comment:60 Changed 7 years ago by bill

In [28889]:

removing colons that shouldn't be there, refs #13101 !strict

comment:61 Changed 7 years ago by bill

In [28890]:

Restore lost info from Dojo 1.6 about djConfig flags. Previously the info was in bootstrap.js, which itself has gone away.

Perhaps these flag descriptions should be spread across separate files (ex: put the description of extraLocales in i18n.js), but for now I put all the dojo/_base config flag descriptions into config.js.

It doesn't include config flags for any dojox packages like dojox/mobile; those definitions should be mixed into dojo/_base/config from a dojox/mobile module.

Changes from 1.6 include:

  • remove debugAtAllCosts, afterOnLoad, skipIeDomLoaded (they seem to no longer be supported)
  • deprecated modulePaths (as per comment in loader code)
  • added parseOnLoad (it was missing from before).


Refs #13101 !strict.

comment:62 Changed 7 years ago by bill

In [28891]:

fix typo in doc comment, refs #13101 !strict.

comment:63 Changed 7 years ago by bill

In [28892]:

skipIeDomLoaded is apparently no longer a djConfig option, refs #13101 !strict.

comment:64 Changed 7 years ago by bill

In [28895]:

dojo/data: api doc comment cleanup, refs #13101 !strict

comment:65 Changed 7 years ago by bill

In [28901]:

Make dojo core module summaries show up in the doc.

This mainly involved moving summaries from the top (ie, the callback method to define()) to the object returned by the module. Or, if the information was duplicated in both places, then just removing the module level info.

There were some cases where I had to introduce faux return values from methods (ex: NodeList?-data.js). Also, I moved a few summaries from a constructor method to the top of the object.

A few modules were impossible to fix:

  • dom-attr, dom-construct, dom-prop: due to the use of exports
  • on, has - because the summary for the function on() is different than the summary for the module containing on() and the other functions hanging off of on.
  • dojo/main - returns the dojo/_base/kernel object but the summary is importantly different: it should say that dojo/main forces all the dojo/_base modules to be loaded


Also fixed various API doc formatting errors,and some spacing errors.

Refs #13101 !strict.

comment:66 Changed 7 years ago by bill

In [28903]:

dijit/form: remove duplicate module summaries (which occurred both at the module level and also in the object returned from the module). Refs #13101 !strict.

comment:67 Changed 7 years ago by bill

In [28905]:

Remove prototype; it was added to help the doc parser but actually it's confusing the doc parser. Now the method summaries are being picked up, although the promise variable itself isn't. Refs #13101 !strict.

Changed 7 years ago by mikeb

updated version of some dojox files, see comment 55, please commit for Michael Billau (IBM, CCLA)

comment:68 Changed 7 years ago by bill

In [28933]:

dojo/behavior: make singleton pattern clearer to parser, and add deprecation warning, refs #13101 !strict.

comment:69 Changed 7 years ago by cjolif

In [28934]:

refs #13101. more API doc fixes thanks Michael Billau (IBM, CCLA).

comment:70 Changed 7 years ago by bill

In [28938]:

dojox/fx: api doc cleanup, refs #13101 !strict.

comment:71 Changed 7 years ago by bill

In [28941]:

API doc cleanup around NodeList, refs #13101 !strict

comment:72 Changed 7 years ago by bill

In [28951]:

misc api doc cleanup, refs #13101 !strict

comment:73 Changed 7 years ago by bill

In [28952]:

properly quote html tags, refs #13101 !strict

comment:74 Changed 7 years ago by cjolif

In [28953]:

refs #13101. This class is tagged private but still appears in the API doc so I needed to fix the doc otherwise it will look ugly.

comment:75 Changed 7 years ago by cjolif

In [28954]:

refs #13101. dojox/charting API doc fixing.

comment:76 Changed 7 years ago by cjolif

In [28955]:

refs #13101. Treemap api doc fixes. !strict.

comment:77 Changed 7 years ago by cjolif

In [28956]:

refs #13101. dojox/date API fix.

comment:78 Changed 7 years ago by cjolif

In [28957]:

refs #13101. More charting api doc.

comment:79 Changed 7 years ago by cjolif

In [28964]:

refs #13101, 15364. Fixes on dojox/mvc API doc + make sure the handler returned by dojox/mvc has a remove method. Thanks Akira Sudoh & Ed Chatelain (IBM, CCLA). !strict.

comment:80 Changed 7 years ago by Patrick Ruzand

In [28975]:

more api fixes for new parser, refs #13101 !strict

comment:81 Changed 7 years ago by Colin Snover

In [29000]:

Refs #13101. Do not run the old broken doc parser on release.

comment:82 Changed 7 years ago by bill

In [29003]:

demos: fix api doc formatting (just for consistency), refs #13101 !strict

comment:83 Changed 7 years ago by bill

In [29005]:

demos: a few more api doc formatting fixes (just for consistency), refs #13101 !strict

comment:84 Changed 7 years ago by bill

In [29006]:

diji: fix api doc formatting, refs #13101 !strict

comment:85 Changed 7 years ago by bill

In [29007]:

dojo core: fix api doc formatting, refs #13101 !strict

comment:86 Changed 7 years ago by bill

In [29008]:

dojox/analytics: fix api doc formatting, refs #13101 !strict

comment:87 Changed 7 years ago by bill

In [29009]:

dojox/atom: fix api doc formatting, in particular removing descriptions that were merely repeats of the summaries, refs #13101 !strict

comment:88 Changed 7 years ago by bill

In [29010]:

dojox/av: fix api doc formatting, refs #13101 !strict

comment:89 Changed 7 years ago by bill

In [29011]:

dojox/calc: fix api doc formatting, refs #13101 !strict

comment:90 Changed 7 years ago by bill

In [29012]:

dojox/charting: fix api doc formatting, refs #13101 !strict

comment:91 Changed 7 years ago by bill

In [29013]:

dojox/collections: fix api doc formatting, refs #13101 !strict

comment:92 Changed 7 years ago by bill

In [29014]:

dojox/data: fix api doc formatting, refs #13101 !strict

comment:93 Changed 7 years ago by bill

In [29015]:

dojox/date: fix api doc formatting, refs #13101 !strict

comment:94 Changed 7 years ago by bill

In [29016]:

dojox/dnd: fix api doc formatting, refs #13101 !strict

comment:95 Changed 7 years ago by bill

In [29017]:

dojox/drawing: Fix api doc formatting, in particular moving class level summary/description of oo.declare() classes into prototype section, so the doc parser will pick them up. Refs #13101 !strict.

comment:96 Changed 7 years ago by bill

In [29018]:

dojox/dtl: fix api doc formatting, refs #13101 !strict.

comment:97 Changed 7 years ago by bill

In [29020]:

dojox/editor: fix api doc formatting, refs #13101 !strict.

comment:98 Changed 7 years ago by bill

In [29021]:

dojox/[ef]*: fix api doc formatting, refs #13101 !strict.

comment:99 Changed 7 years ago by bill

In [29022]:

dojox/gauges: fix api doc formatting, refs #13101 !strict.

comment:100 Changed 7 years ago by bill

In [29023]:

dojox/editor, geo, gesture, gfx* api doc updates, refs #13101 !strict

comment:101 Changed 7 years ago by bill

In [29024]:

dojox/grid: api doc updates, refs #13101 !strict

comment:102 Changed 7 years ago by bill

In [29025]:

util: api doc updates, refs #13101 !strict

comment:103 Changed 7 years ago by bill

In [29026]:

dojox/[h-l]*: api doc updates, refs #13101 !strict

comment:104 Changed 7 years ago by bill

In [29028]:

dojox/m*: api doc updates, refs #13101 !strict

comment:105 Changed 7 years ago by bill

In [29029]:

dojox/mobile: remove duplicate summaries. A summary on the object returned from the module is sufficient; the module shouldn't have it's own summary too. Refs #13101 !strict.

comment:106 Changed 7 years ago by bill

In [29030]:

dojox/mobile: Put summary inside the object returned from the module, rather than at the module level itself, and other changes in order to make both module level summary and module's list of methods show up in API doc. Refs #13101 !strict.

comment:107 Changed 7 years ago by bill

In [29031]:

dojox/mobile: declare singletons in a way more understandable to me and the doc parser. Although, it seems like these singletons could and should be replaced by a simple hash of functions, like we did for the parser.

Refs #13101 !strict.

comment:108 Changed 7 years ago by bill

In [29032]:

dojox/[r-v]*: api doc formatting fixes, refs #13101 !strict.

comment:109 Changed 7 years ago by bill

In [29033]:

dojox/widget: api doc formatting fixes, refs #13101 !strict.

comment:110 Changed 7 years ago by bill

In [29034]:

dojox/wire: api doc formatting fixes, refs #13101 !strict.

comment:111 Changed 7 years ago by bill

In [29035]:

dojox: a few more api doc formatting fixes, refs #13101 !strict.

comment:112 Changed 7 years ago by bill

In [29036]:

oops, this module is supposed to return a class, not a singleton, refs #13101 !strict.

comment:113 Changed 7 years ago by bill

In [29046]:

dojox: a few more api doc formatting fixes, refs #13101 !strict.

Changed 7 years ago by Eric Durocher

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)

comment:114 Changed 7 years ago by cjolif

In [29058]:

refs #13101. More dojox/css3 API doc fixes, mainly remove faux returns values and move doc inside returned object - Thanks Eric Durocher (IBM, CCLA)

Changed 7 years ago by Adrian Vasiliu

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)

comment:115 Changed 7 years ago by cjolif

In [29060]:

refs #13101.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. Thanks Adrian Vasiliu (IBM, CCLA). !strict.

comment:116 Changed 7 years ago by bill

In [29064]:

fix dojo core and dijit markdown to have blank lines surrounding lists, refs #13101 !strict

comment:117 Changed 7 years ago by cjolif

In [29066]:

refs #13101. More api doc fixes from Adrian Vasiliu (IBM, CCLA). !strict.

comment:118 Changed 7 years ago by cjolif

In [29067]:

refs #13101. Fix API doc issue introduce by a previous commit.

comment:119 Changed 7 years ago by bill

In [29088]:

doh: fix doc comments and some of the coding style violations, refs #13101 !strict.

comment:120 Changed 7 years ago by bill

In [29100]:

add TODO's about module summary, refs #13101 !strict

comment:121 Changed 7 years ago by bill

In [29103]:

fix formatting of list, refs #13101 !strict

comment:122 Changed 7 years ago by bill

In [29105]:

fix code block formatting, refs #13101 !strict

comment:123 Changed 7 years ago by bill

In [29106]:

Fix documentation of widget constructors, refs #13101 !strict.

Since the inheritance of method summaries isn't working yet, I tended to repeat the constructor() summary for any widget with it's own constructor. However, that may be better anyway, since the description ideally should vary from widget to widget w.r.t. the use of srcNodeRef (whether the widget replaces srcNodeRef or attaches to it, whether srcNodeRef is required or optional, and whether the contents of srcNodeRef are used).

comment:124 Changed 7 years ago by bill

In [29107]:

Fix typo from [29106], refs #13101 !strict.

Changed 7 years ago by Adrian Vasiliu

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)

comment:125 Changed 7 years ago by bill

In [29109]:

dojox: list formatting fixes (mainly putting needed blank lines around lists), refs #13101 !strict, patch from Adrian Vasiliu (IBM, CCLA), thanks!

comment:126 Changed 7 years ago by bill

In [29110]:

numbered list formatting fixes, refs #13101 !strict

comment:127 Changed 7 years ago by bill

In [29111]:

Lists should not be indented, except for nested lists, refs #13101 !strict

comment:128 Changed 7 years ago by bill

In [29112]:

another list fix, refs #13101 !strict

comment:129 Changed 7 years ago by bill

In [29114]:

Fix indentation errors: our API doc shouldn't have any indentation (beyond the initial two tabs) except for code blocks or nested lists. Refs #13101 !strict

comment:130 Changed 7 years ago by bill

In [29116]:

Fix indentation errors (part 3): our API doc shouldn't have any indentation (beyond the initial two tabs) except for code blocks or nested lists. Refs #13101 !strict

comment:131 Changed 7 years ago by bill

In [29117]:

Standardize on "-" rather than "*" for unordered lists, since "*" doesn't work, and also since most of our code is already using "-". Refs #13101 !strict

comment:132 Changed 7 years ago by bill

In [29121]:

Fix regression from [29031], about migrationAssistant being undefined, thanks Eric. Refs #13101 !strict.

comment:133 Changed 7 years ago by bill

In [29132]:

doc for dijit/Dialog class, refs #13101 !strict

comment:134 Changed 7 years ago by bill

In [29133]:

trying to fix doc issues around dojo/NodeList, refs #13101 !strict

comment:135 Changed 7 years ago by bill

In [29134]:

get dojo/on doc to show up, refs #13101 !strict

comment:136 Changed 7 years ago by bill

In [29136]:

fixing more malformed doc, refs #13101 !strict

comment:137 Changed 7 years ago by bill

In [29145]:

fixing more malformed doc, refs #13101 !strict

comment:138 Changed 7 years ago by dylan

In [29161]:

refs #13101, add some summary and description fields to a few of the methods for AccordionContainer?... others still need to be added

comment:139 Changed 7 years ago by dylan

In [29162]:

refs #13101, add missing description of StackContainer?.resize, !strict

comment:140 Changed 7 years ago by dylan

In [29163]:

refs #13101, revert previous commits as this is intentional and an open issue at https://github.com/csnover/js-doc-parse/issues/21 , !strict

comment:141 Changed 7 years ago by bill

In [29164]:

fix summary, refs #13101.

comment:142 Changed 7 years ago by bill

In [29165]:

dojo/i18n: use dojodoc format for comments, refs #13101 !strict

comment:143 Changed 7 years ago by bill

In [29166]:

dojox/grid: fixing things supposed to be marked as private, and removing apparently unused "themable" property, refs #13101 !strict

comment:144 Changed 7 years ago by bill

In [29167]:

fixing various NodeList? doc problems, refs #13101 !strict

comment:145 Changed 7 years ago by bill

In [29172]:

pseudo-definition must come after real one to override it, refs #13101 !strict

comment:146 Changed 7 years ago by dylan

In [29174]:

refs #13101, refine the dojo/ready docs for the doc parser to use AMD for examples

comment:147 Changed 7 years ago by bill

In [29176]:

Fix dijit/_base API doc, in particular only show the symbols exported by each module, even if the module (for back-compat reasons) is returning dijit itself. Refs #13101 !strict.

comment:148 Changed 7 years ago by bill

In [29177]:

dojox/mvc: Prevent mvc from affecting the documentation for _WidgetBase, by hiding mixed-in values and by using dojo/aspect to connect to _WidgetBase methods rather than monkey patching them. Refs #13101 !strict

comment:149 Changed 7 years ago by bill

In [29178]:

For properties created by parent widgets (like BorderContainer) that are set on child widgets, document the properties on sub-pages of the parent widget, rather than on the _WidgetBase page. Refs #13101 !strict.

Changed 7 years ago by Eric Durocher

Document dojox/mobile "child widget properties" similar to bill's last changes in BorderContainer? etc. - Eric Durocher (IBM, CCLA)

comment:150 Changed 7 years ago by dylan

In [29183]:

add documentation for getSchema in dojox/data/ServiceStore, refs #13101

comment:151 Changed 7 years ago by dylan

In [29187]:

JsonRest?/put returns _base/Deferred, not Number, refs #13101

comment:152 Changed 7 years ago by bill

In [29188]:

hiding a few more monkey patches from the parser, refs #13101 !strict.

comment:153 Changed 7 years ago by bill

In [29193]:

dojox/mvc: fix doc for at.handle (it shouldn't assume that a dojox global variable exists), refs #13101 !strict.

comment:154 Changed 7 years ago by cjolif

In [29198]:

refs #13101. Document dojox/mobile "child widget properties" similar to bill's last changes in BorderContainer. Thanks Eric Durocher (IBM, CCLA). !strict.

comment:155 Changed 7 years ago by bill

In [29225]:

fix number.round() doc, refs #13101 !strict

comment:156 Changed 7 years ago by bill

In [29226]:

Oops, [29167] removed the undocumented removeAttr() method. Putting it back. Refs #13101 !strict.

comment:157 Changed 7 years ago by dylan

In [29234]:

refs #13101, update dojo/dom-class inline examples to use AMD syntax

comment:158 Changed 7 years ago by dylan

In [29235]:

refs #13101, update WidgetSet? inline examples to use AMD syntax

comment:159 Changed 7 years ago by bill

In [29239]:

Update dojox.profile.js with modules converted to AMD, fixes #15248, #15301, refs #13101,

comment:160 Changed 7 years ago by cjolif

In [29255]:

refs #13101. Fixes to charting API doc.

comment:161 Changed 7 years ago by cjolif

In [29256]:

refs #13101. Small fix.

comment:162 Changed 7 years ago by cjolif

In [29264]:

refs #13101. Follow Bill's suggestion to solve kwArgs API doc issues.

comment:163 Changed 7 years ago by cjolif

In [29265]:

refs #13101. Follow Bill's suggestion to solve kwArgs API doc issues.

comment:164 Changed 7 years ago by cjolif

In [29267]:

refs #13101. More kwArgs fixes, thanks to Bill.

comment:165 Changed 7 years ago by bill

In [29268]:

Add doc to top level dojox/ files, in general telling people to load the individual modules inside the package directories instead, refs #13101 !strict.

comment:166 Changed 7 years ago by Kitson Kelly

In [29281]:

refs #13101, add missing API doc types !strict

comment:167 Changed 7 years ago by bill

In [29283]:

technically tabIndex is a string, refs #13101 sort of, !strict

comment:168 Changed 7 years ago by dylan

In [29327]:

fix documentation broken link, refs #13101, !strict

comment:169 Changed 7 years ago by Colin Snover

In [29350]:

Refs #13101. Fix removal of doc parser from script also removed a necessary cd call.

comment:170 Changed 7 years ago by bill

In [29351]:

Doc-only update. Complex.js overrides dojo/_base/fx.animateProperty, but hide that from the doc parser because it obscures the original definition of the function. Also add faux-return value to complex.js module to get reasonable module-level documentation. Refs #13101 !strict.

comment:171 Changed 7 years ago by bill

In [29352]:

Doc-only update. timezone.js overrides dojo/date/locale format() and _getZone() methods, but hide that from the doc parser because it obscures the original definitions of the functions. This module in general needs an overhaul though, to return a module value rather than setting global variables. Refs #13101 !strict.

comment:172 Changed 7 years ago by bill

In [29354]:

Doc only commit. Simplify kwargs definitions and workaround doc parser bugs when kwargs is declared as a function, refs #13101 !strict.

comment:173 Changed 7 years ago by Kitson Kelly

In [29355]:

Inline doc only, fix delegate signature, refs #13101 !strict

comment:174 Changed 7 years ago by bill

In [29357]:

doc fixes, for QueryResults, refs #13101

comment:175 Changed 7 years ago by bill

In [29358]:

dijit, dojo, util: fix more dojodoc misformatting, refs #13101 !strict

comment:176 Changed 7 years ago by bill

In [29359]:

dojox: fix more dojodoc misformatting, refs #13101 !strict

comment:177 Changed 7 years ago by dylan

In [29361]:

refs #13101, add missing dojo config docs for deps and callback properties, !strict

comment:178 Changed 7 years ago by bill

In [29365]:

make definition of declare's return value appear in API doc, refs #13101 !strict.

comment:179 Changed 7 years ago by bill

In [29366]:

since inlined type definitions don't work for union types, use MID+property which turns into a hyperlink, refs #13101 !strict

comment:180 Changed 7 years ago by bill

In [29369]:

comment on line declaring the module export hides the export's summary, refs #13101 and https://github.com/csnover/js-doc-parse/issues/66 !strict.

comment:181 Changed 7 years ago by bill

In [29370]:

don't mask real definition of ioPublish, refs #13101 !strict

comment:182 Changed 7 years ago by bill

In [29371]:

Dojo core: use MIDs rather than global variables in summaries and descriptions, so that the hyperlinks work. Refs #13101 !strict

comment:183 Changed 7 years ago by bill

In [29372]:

Dijit: use MIDs rather than global variables in summaries and descriptions, so that the hyperlinks work. Refs #13101 !strict

comment:184 Changed 7 years ago by bill

In [29374]:

fix dojox/mobile/Button doc, refs #13101 !strict

comment:185 Changed 7 years ago by bill

In [29376]:

dojox/gfx: prevent code in _gfxBidiSupport.js from masking definitions of properties done in _base.js, refs #13101 !strict

comment:186 Changed 7 years ago by bill

In [29383]:

dojox/data: use MIDs rather than globals in doc comments, and other doc fixes, refs #13101 !strict

comment:187 Changed 7 years ago by bill

In [29384]:

second try to fix _gfxBidiSupport.js so it doesn't mask definitions in _base.js, refs #13101, #15688 !strict

comment:188 Changed 7 years ago by bill

In [29386]:

dojox/data: use MIDs rather than globals in doc comments, and other doc fixes, refs #13101 !strict

comment:189 Changed 7 years ago by bill

In [29387]:

Tweaking union types (mainly removing spaces) so the doc parser understands them, refs #13101 !strict

comment:190 Changed 7 years ago by bill

In [29388]:

fix keyword, should be "tags" not "tag", refs #13101 !strict.

comment:191 Changed 7 years ago by Kitson Kelly

In [29389]:

adding missing API doc types, refs #13101 !strict

comment:192 Changed 7 years ago by bill

In [29467]:

fix api doc parsing for dojo/json, refs #13101 !strict

comment:193 Changed 7 years ago by Colin Snover

Milestone: 1.82.0

1.8 has been tagged; moving all outstanding tickets to next major release milestone.

comment:194 Changed 7 years ago by bill

Milestone: 2.01.8
Resolution: fixed
Status: assignedclosed
Type: defectfeature

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:195 Changed 7 years ago by bill

In [29470]:

fix hyperlinks for dojo/store, refs #13101 !strict

comment:196 Changed 7 years ago by bill

In [29471]:

clarify description of constructor, refs #13101 !strict

comment:197 Changed 7 years ago by bill

In [29472]:

merge [29467], [29470], [29471] to 1.8/ branch, refs #13101 !strict

comment:198 Changed 7 years ago by dylan

In [29548]:

refs #13101, clean-up docs

comment:199 Changed 7 years ago by dylan

In [29549]:

refs #13101, clean-up docs in 1.8 branch

comment:200 Changed 7 years ago by bill

In [29573]:

api doc updates, refs #13101 !strict

comment:201 Changed 7 years ago by bill

In [29574]:

Backport [29573] doc updates to 1.8/ branch, refs #13101 !strict.

comment:202 Changed 6 years ago by bill

In [30255]:

fix API doc for Dye pseudo-class, refs #13101 !strict

comment:203 Changed 6 years ago by bill

In [31171]:

fix module summary to show up in API doc, refs #13101 !strict

comment:204 Changed 6 years ago by bill

In [31184]:

Fix return values of AMD modules, refs #13101 !strict

comment:205 Changed 6 years ago by bill

In [31186]:

Fix return values of dojox/data AMD modules, refs #13101 !strict

comment:206 Changed 6 years ago by bill

In [31187]:

Fix return values of dojox/date AMD modules, refs #13101 !strict

comment:207 Changed 6 years ago by bill

In [31188]:

Cleanup return values of dojox/dtl AMD modules, refs #13101 !strict

comment:208 Changed 6 years ago by bill

In [31189]:

more AMD cleanup of dojox/dtl, refs #13101 !strict

comment:209 Changed 6 years ago by bill

In [31190]:

more AMD cleanup of dojox/dtl, refs #13101 !strict

comment:210 Changed 6 years ago by bill

In [31209]:

fix API doc parsing error, refs #13101

comment:211 Changed 6 years ago by bill

In [31210]:

Fix module return values for dojox/editor plugins, refs #13101 !strict. The modules need a lot more AMD work in general though.

comment:212 Changed 6 years ago by bill

In [31211]:

Fix module return values for various dojox modules, refs #13101 !strict.

comment:213 Changed 6 years ago by bill

In [31230]:

fix module return value error from [31184], refs #13101 !strict

comment:214 Changed 6 years ago by Bill Keese <bill@…>

In f7f44ef2152f3fa3aac131ad267763e74fbb84d0/dojo:

Error: Processor CommitTicketReference failed
Unsupported version control system "git": Can't find an appropriate component, maybe the corresponding plugin was not enabled? 

comment:215 Changed 6 years ago by Bill Keese <bill@…>

In 0b4519832d9c4ae75a2afd626b2a6f4c9141f1f5/dojo:

Error: Processor CommitTicketReference failed
Unsupported version control system "git": Can't find an appropriate component, maybe the corresponding plugin was not enabled? 

comment:216 Changed 5 years ago by bill

Partially backported to 1.7 in e7403082d02faba2e47cb645d2532dd2920f60b8.

comment:217 Changed 5 years ago by ben hockey <neonstalwart@…>

In abae7b172cdc36f16a0075fb20283518aa2f52a7/dojox:

Error: Processor CommitTicketReference failed
Unsupported version control system "git": Can't find an appropriate component, maybe the corresponding plugin was not enabled? 

comment:218 Changed 5 years ago by ben hockey <neonstalwart@…>

In eb09802b47312b9dee5506223b2b2d4ccda78742/dojox:

Error: Processor CommitTicketReference failed
Unsupported version control system "git": Can't find an appropriate component, maybe the corresponding plugin was not enabled? 

comment:219 Changed 5 years ago by ben hockey <neonstalwart@…>

In 4208e11f76fac92d072a1b90f59c646af4cfc039/dojox:

Error: Processor CommitTicketReference failed
Unsupported version control system "git": Can't find an appropriate component, maybe the corresponding plugin was not enabled? 
Note: See TracTickets for help on using tickets.