Opened 11 years ago

Closed 11 years ago

Last modified 10 years ago

#5962 closed task (fixed)

[meta] inline doc cleanup

Reported by: alex Owned by: anonymous
Priority: high Milestone: 1.2
Component: General Version: 1.0
Keywords: documentation, docs, jsdoc Cc:
Blocked By: Blocking:

Description (last modified by bill)

now that redesign is showing us what's really being generated out of our documentation, this is the time to clean it all up, make it purdy, and throw in all those examples we've been meaning to get around to.

This ticket is a meta-ticket to serve as a checkin ref for doc cleanup in Core and Dijit.

To arms....er....editors!

Change History (76)

comment:1 Changed 11 years ago by alex

(In [12677]) doc cleanup. Refs #5962. !strict

comment:2 Changed 11 years ago by dylan

See #5379 for djConfig, and its associated parameters, which need clean-up, ​http://redesign.dojotoolkit.org/jsdoc/dojo/HEAD/djConfig

comment:3 Changed 11 years ago by alex

(In [12699]) cleanup docs for fx functions. Add some more examples. Refs #5962. !strict

comment:4 Changed 11 years ago by Neil Roberts

(In [12712]) Refs #5962. Mark code as code !strict

comment:5 Changed 11 years ago by Neil Roberts

(In [12713]) Refs #5962. Format the summary when needed

comment:6 Changed 11 years ago by Neil Roberts

(In [12719]) Refs #5962. Revert marking code as code !strict

comment:7 Changed 11 years ago by Neil Roberts

(In [12723]) Refs #5962. Markdown any problematic HTML !strict

comment:8 Changed 11 years ago by Neil Roberts

(In [12724]) Refs #5962. Markdown any problematic HTML !strict

comment:9 Changed 11 years ago by Neil Roberts

(In [12725]) Refs #5962. Markdown any problematic HTML !strict

comment:10 Changed 11 years ago by Neil Roberts

(In [12728]) Refs #5962. Markdown any problematic HTML !strict

comment:11 Changed 11 years ago by Adam Peller

(In [12790]) Use markdown, kwargs in docs. Refs #5962

comment:12 Changed 11 years ago by alex

(In [12814]) inline doc cleanup for the default loader. Refs #5962. !strict

comment:13 Changed 11 years ago by alex

(In [12821]) make sources configurable through passed properties for *all* attributes. Update and clarify docs. Refs #5962. !strict

comment:14 Changed 11 years ago by alex

(In [12823]) updating inline documentation for the bootstrap. Refs #5962. !strict

comment:15 Changed 11 years ago by alex

(In [12824]) update documentation for browser detection variables. Refs #5962. !strict

comment:16 Changed 11 years ago by alex

(In [12827]) update core documentation for query, re-enable the query optimizer, update misc docs around the rest of dojo.js as well. Refs #5962. !strict

comment:17 Changed 11 years ago by alex

(In [12828]) comment cleanup and code shortening. Also expanding test cases to handle default param packing. Refs #3961. Refs #5962. Refs #3121. !strict

comment:18 Changed 11 years ago by Neil Roberts

(In [12833]) Refs #5962 and r12790. Update markdown and pseudo-args

comment:19 Changed 11 years ago by Neil Roberts

(In [12834]) Refs #5962 and r12821. Instance variables won't show up in docs if there are no instance variables. !strict

comment:20 Changed 11 years ago by Neil Roberts

(In [12835]) Refs #5962 and r12824. Properly type the browser detection variables !strict

comment:21 Changed 11 years ago by Neil Roberts

(In [12836]) Refs #5962 and r12827. Make sure that nested lists are properly nested !strict

comment:22 Changed 11 years ago by Neil Roberts

(In [12837]) Refs #5962. Remove parameters, they confuse people !strict

comment:23 Changed 11 years ago by Neil Roberts

(In [12840]) Refs #5962. Update djConfig params

comment:24 Changed 11 years ago by Adam Peller

(In [12841]) Correct kwArgs doc declaration, plus some other doc fixups. !strict Refs #5962 and r12790

comment:25 Changed 11 years ago by Adam Peller

(In [12856]) Doc function param. Refs #5962

comment:26 Changed 11 years ago by Adam Peller

(In [12859]) Improve docs and markdown. Refs #5962

comment:27 Changed 11 years ago by Adam Peller

(In [12862]) Improve docs and markdown. Refs #5962

comment:28 Changed 11 years ago by alex

(In [12867]) clobbering crufty djConfig values, adding docs for the stuff we actually use on a regular basis, and updating DOH to give us better command-line info. Refs #5962. !strict

comment:29 Changed 11 years ago by Adam Peller

(In [12872]) Doc fixups. Refs #5962 !strict

comment:30 Changed 11 years ago by dante

(In [12893]) refs #5962 - show query().style() example in dojo.style() and document common pitfall. !strict

comment:31 Changed 11 years ago by Adam Peller

(In [12917]) Add docs. Refs #5962 !strict

comment:32 Changed 11 years ago by Adam Peller

(In [12918]) Add docs. Refs #5962 !strict

comment:33 Changed 11 years ago by Adam Peller

(In [12921]) Add docs. Refs #5962 !strict

comment:34 Changed 11 years ago by dante

(In [12926]) refs #5962 - returns vs Returns might still confuse jsdoc

comment:35 Changed 11 years ago by Neil Roberts

(In [12927]) Refs #5962. Add constraints var. !strict

comment:36 Changed 11 years ago by Adam Peller

(In [12940]) Add plugin docs. Refs #5962

comment:37 Changed 11 years ago by Adam Peller

(In [12945]) Fix markdown. Refs #5962 !strict

comment:38 Changed 11 years ago by Adam Peller

(In [12947]) Fix markdown. Take 3. Refs #5962 !strict

comment:39 Changed 11 years ago by Adam Peller

(In [12948]) Fix markdown. Take 4. Refs #5962 !strict

comment:40 Changed 11 years ago by Neil Roberts

(In [12949]) Refs #5962. Update Markdown !strict

comment:41 Changed 11 years ago by Neil Roberts

(In [12950]) Refs #5962. Make sure pseudo-code is properly formatted !strict

comment:42 Changed 11 years ago by Neil Roberts

(In [12951]) Refs #5962. Markdown take eleventy-billion !strict

comment:43 Changed 11 years ago by Neil Roberts

(In [12952]) Refs #5962. Make sure pseudo-code is properly formatted !strict

comment:44 Changed 11 years ago by Neil Roberts

(In [12953]) Refs #5962. Markdown take eleventy-billion and one !strict

comment:45 Changed 11 years ago by Neil Roberts

(In [12955]) Refs #5962. Remove local modification !strict

comment:46 Changed 11 years ago by Adam Peller

(In [12965]) Clean up summaries a bit. Refs #5962 !strict

comment:47 Changed 11 years ago by Neil Roberts

(In [12969]) Refs #5962. Make sure pseudo-code is properly formatted !strict

comment:48 Changed 11 years ago by alex

(In [13059]) minor doc formatting update. Refs #5962 !strict

comment:49 Changed 11 years ago by Adam Peller

(In [13069]) fix cookie props doc. Refs #5962 !strict

comment:50 Changed 11 years ago by Adam Peller

(In [13115]) Replace some ", optional" doc strings, emphasize arg type for setValue. Refs #5962 !strict

comment:51 Changed 11 years ago by Adam Peller

(In [13116]) A little more clarity on this.value. Refs #5962 !strict

comment:52 Changed 11 years ago by Adam Peller

(In [13118]) Some clarification around dir/lang attributes. Refs #5962 !strict

comment:53 Changed 11 years ago by Adam Peller

(In [13119]) Add hypertext link to docs. Refs #5962 !strict

comment:54 Changed 11 years ago by Adam Peller

(In [13121]) Improve djConfig docs. Refs #5962

comment:55 Changed 11 years ago by Adam Peller

(In [13124]) Improve docs. Refs #5962 !strict

comment:56 Changed 11 years ago by James Burke

(In [13134]) Refs #5962. Apparent typo in docs for dojo.delegate !strict

comment:57 Changed 11 years ago by Douglas Hays

(In [13178]) References #5962. Removed some TODOCs and fixed some summary formatting.

comment:58 Changed 11 years ago by Adam Peller

(In [13179]) Fix [13178] to document function args individually. Refs #5962

comment:59 Changed 11 years ago by Adam Peller

(In [13180]) Make doc parser happy. Refs #5962

comment:60 Changed 11 years ago by Adam Peller

(In [13184]) Clean up docs. Refs #5962 !strict

comment:61 Changed 11 years ago by Adam Peller

(In [13185]) Clean up docs. Refs #5962 !strict

comment:62 Changed 11 years ago by Adam Peller

(In [13187]) Clean up docs. Refs #5962 !strict

comment:63 Changed 11 years ago by Adam Peller

(In [13188]) Clean up docs. Refs #5962 !strict

comment:64 Changed 11 years ago by Adam Peller

(In [13190]) Clean up docs. Refs #5962 !strict

comment:65 Changed 11 years ago by Adam Peller

(In [13192]) Clean up docs. Refs #5962 !strict

comment:66 Changed 11 years ago by alex

(In [13399]) adding example config data. Refs #5962

comment:67 Changed 11 years ago by dante

(In [13411]) refs #5962

comment:68 Changed 11 years ago by dante

(In [13413]) refs #5962 because I can't find an open ticket regarding dijit tests ... Minus the 404 in this test (fixed), it seems horribly broken overall.

comment:69 Changed 11 years ago by bill

(In [13954]) Fix comments, refs #5962 !strict

comment:70 Changed 11 years ago by alex

(In [14027]) updating inline docs, adding examples, etc. Refs #5962. !strict (like most things in _base)

comment:71 Changed 11 years ago by alex

(In [14043]) update docs and unit tests. Also ensure that scoping is correct in dojo.string.substitute() formatters. Fixes #6247. Refs #5962

comment:72 Changed 11 years ago by bill

Description: modified (diff)
Milestone: 1.2 → future

comment:73 Changed 11 years ago by bill

(In [14558]) Update documentation and remove some unused code. Refs #5962 !strict.

comment:74 Changed 11 years ago by dante

Resolution: → fixed
Status: new → closed

see #7461 - the newer of these [meta] tickets (newer show up in search first, and as time passes they become hard to find again)

comment:75 Changed 11 years ago by bill

Milestone: future → 1.2

comment:76 Changed 10 years ago by Adam Peller

(In [17518]) Style and doc updates. Refs #5962

Note: See TracTickets for help on using tickets.