Opened 12 years ago

Closed 12 years ago

Last modified 12 years ago

#4820 closed defect (fixed)

update Core inline docs

Reported by: alex Owned by: alex
Priority: high Milestone: 1.0
Component: Core Version: 0.9
Keywords: documentation Cc: Neil Roberts, dante
Blocked By: Blocking:

Description

after discussion w/ pottedmeat, we need to:

  • refactor Base and Core docs to drop the "usage" param and replace it with "examples"
  • make use of /*===== blocks for documentation of generated or clever definitions
  • ensure full doc coverage

Change History (46)

comment:1 Changed 12 years ago by alex

(In [11112]) usage -> examples. Refs #4820

comment:2 Changed 12 years ago by Neil Roberts

(In [11140]) Refs #4820. Updated examples and descriptions that use code to work with tomorrow's API tool update.

comment:3 Changed 12 years ago by alex

(In [11151]) expanding documentation and reducing file size for dojo.NodeList?. Refs #4820

comment:4 Changed 12 years ago by alex

(In [11152]) minor doc update. Refs #4820

comment:5 Changed 12 years ago by Neil Roberts

(In [11198]) Refs #4820. Update to show external-doc style

comment:6 Changed 12 years ago by alex

(In [11215]) docs for dojo.loaded and dojo.unloaded. Refs #4820

comment:7 Changed 12 years ago by alex

(In [11216]) make dojo.delegate public and add docs. Refs #4820

comment:8 Changed 12 years ago by alex

(In [11217]) add back in docs for deprecated() and experimental(). Refs #4820

comment:9 Changed 12 years ago by alex

(In [11218]) updating inline docs such that they get picked up by the parser. Refs #4820

comment:10 Changed 12 years ago by alex

(In [11224]) go with "example" instead of "usage". Refs #4820

comment:11 Changed 12 years ago by alex

(In [11225]) clean up doc formatting and a bit of structure. Also some code size reductions. Refs #4820. Refs #3961

comment:12 Changed 12 years ago by James Burke

(In [11254]) Refs #4820. Format the kwArgs docs for IO methods so they show up nice in the parsed docs.

comment:13 Changed 12 years ago by James Burke

(In [11255]) Refs #4820. Try to avoid the user from hitting a bundle loading error case.

comment:14 Changed 12 years ago by Neil Roberts

(In [11336]) Refs #4820. Update documentation

comment:15 Changed 12 years ago by Neil Roberts

(In [11339]) Refs #4820. Cleaning up documentation

comment:16 Changed 12 years ago by Neil Roberts

(In [11356]) Refs #4820. Documentation updates

comment:17 Changed 12 years ago by Neil Roberts

(In [11363]) Refs #4820. Documentation updates

comment:18 Changed 12 years ago by alex

(In [11376]) minor doc updates. Refs #4820

comment:19 Changed 12 years ago by alex

(In [11377]) minor doc update. Refs #4820

comment:20 Changed 12 years ago by alex

(In [11378]) minor doc updates and formatting for debugging. Refs #4820. toJson() no longer tries to handle DOM nodes. Fixes #4186

comment:21 Changed 12 years ago by alex

(In [11379]) documentation updates. Refs #4820

comment:22 Changed 12 years ago by alex

(In [11380]) documentation updates. Refs #4820

comment:23 Changed 12 years ago by alex

(In [11381]) minor formatting updates. Refs #4820

comment:24 Changed 12 years ago by alex

(In [11382]) minor doc formatting updates for readability. Refs #4820

comment:25 Changed 12 years ago by alex

(In [11383]) clean up doc formatting. Refs #4820

comment:26 Changed 12 years ago by alex

(In [11385]) comment formatting cleanup. Refs #4820

comment:27 Changed 12 years ago by alex

(In [11386]) update for dojo.cookie() docs. Refs #4820

comment:28 Changed 12 years ago by alex

(In [11387]) doc updates to ensure that we capture the optional property bags correctly. Refs #4820

comment:29 Changed 12 years ago by alex

Resolution: fixed
Status: newclosed

comment:30 Changed 12 years ago by dante

(In [11481]) refs #4820 - dijit doc updates to trunk only

comment:31 Changed 12 years ago by dante

(In [11482]) refs #4820 - more simple doc fill-ins

comment:32 Changed 12 years ago by dante

(In [11488]) refs #4820 - doc updates

comment:33 Changed 12 years ago by dante

(In [11489]) refs #4820 - more docs

comment:34 Changed 12 years ago by dante

(In [11490]) refs #4820 - documnetation updates

comment:35 Changed 12 years ago by dante

(In [11496]) refs #4820 - dialog doc update

comment:36 Changed 12 years ago by dante

(In [11498]) refs #4820 and refs #4901 - doc additions and one small superlclass.apply change

comment:37 Changed 12 years ago by dante

(In [11500]) refs #4820 - doc updates

comment:38 Changed 12 years ago by dante

(In [11501]) refs #4820 - more doc updates.

comment:39 Changed 12 years ago by Adam Peller

(In [11755]) Fix doc typos. Refs #4820

comment:40 Changed 12 years ago by alex

(In [12289]) expand docs for registerModulePath(). Refs #4820

comment:41 Changed 12 years ago by Neil Roberts

(In [12348]) Refs #4820

  • The bane of Torrey's existence is now fixed
  • FadeArgs? will now show up properly in docs
  • !strict

comment:42 Changed 12 years ago by Adam Peller

(In [12607]) Fix up comments to match signatures, show multiple types on arguments and document their behavior, use common naming of parameters. Refs #4820

comment:43 Changed 12 years ago by Adam Peller

(In [12665]) fixup docs. Refs #4820 !strict

comment:44 Changed 12 years ago by Adam Peller

(In [12667]) Better, but still not great, definition for dojo.data. Refs #4820

comment:45 Changed 12 years ago by Adam Peller

(In [12701]) Ok, it really was JavaScript? 1.6, despite the misleading URLs. Refs #4820

comment:46 Changed 12 years ago by bill

(In [13921]) Put colon after "summary" keyword, refs #4820 !strict

Note: See TracTickets for help on using tickets.