Opened 11 years ago

Closed 11 years ago

Last modified 10 years ago

#7461 closed enhancement (fixed)

[meta] clean up documentation

Reported by: Neil Roberts Owned by:
Priority: high Milestone: 1.3
Component: Documentation Version: 1.1.1
Keywords: Cc:
Blocked By: Blocking:

Description

Find and clean up any issues

Attachments (1)

revision.diff (1.5 KB) - added by ben hockey 11 years ago.
looks like order of params have swapped at some point and added ? to inline docs for optional params

Download all attachments as: .zip

Change History (41)

comment:1 Changed 11 years ago by Neil Roberts

(In [14879]) Refs #7461. Clean up returns statements !strict

comment:2 Changed 11 years ago by bill

Milestone: 1.2future
Summary: Clean up documentation[meta] clean up documentation

comment:3 Changed 11 years ago by dante

(In [14993]) refs #7461 - small cleanups

comment:4 Changed 11 years ago by dante

(In [14999]) refs #7461 - update fx.easing inline docs and style adherance !strict

comment:5 Changed 11 years ago by Nathan Toone

(In [15010]) Refs #7461 - document default value for position !strict

comment:6 Changed 11 years ago by dante

(In [15027]) refs #7461 - updates inline docs for NodeList?-html

comment:7 Changed 11 years ago by dante

(In [15157]) refs #7461 - add example and words to animateProperty docs. !strict

comment:8 Changed 11 years ago by dante

(In [15172]) refs #7461 - minor doc change in WizardPane?

comment:9 Changed 11 years ago by bill

Component: Doc parserDocumentation
Owner: Neil Roberts deleted

comment:10 Changed 11 years ago by dante

(In [15276]) refs #7461 - djConfig.require: Array was not documented.

comment:11 Changed 11 years ago by Adam Peller

(In [15277]) add a comma, remove a comma. Refs #7461

comment:12 Changed 11 years ago by dante

(In [15278]) refs #7461 - commas are being evasive today

comment:13 Changed 11 years ago by Adam Peller

(In [15309]) Fix docs for num arg on rep. Refs #7461

comment:14 Changed 11 years ago by Adam Peller

(In [15310]) Fill in example for dojo.string.pad. Refs #7461

Changed 11 years ago by ben hockey

Attachment: revision.diff added

looks like order of params have swapped at some point and added ? to inline docs for optional params

comment:15 Changed 11 years ago by dante

revision.diff applied in [15541] - thanks neonstalwart

comment:16 Changed 11 years ago by Adam Peller

(In [15980]) explain 'orient' property in docs. Refs #7461

comment:17 Changed 11 years ago by dante

add base/Color doc expansion in [16157]

comment:18 Changed 11 years ago by dante

(In [16184]) refs #7802 and refs #7461 - adding better docs for dojo.create (noting about alias to dojo.doc.createElement) and adding other examples. !strict

comment:19 Changed 11 years ago by dante

(In [16202]) refs #7461 - "returns" needs to be capitol, else jsdoc picks the description up as a return value. !strict

comment:20 Changed 11 years ago by dante

(In [16245]) ha! this isn't trac. refs #7461

comment:21 Changed 11 years ago by dante

(In [16269]) refs #7461 - simple markdown that isn't actually linking yet, but should (will)

comment:22 Changed 11 years ago by dante

(In [16270]) refs #7461 - forcing fix of jsdoc mixin bug. mixing in defaultDuration into dijit so it gets documented (in a pseudo-block)

comment:23 Changed 11 years ago by dante

(In [16332]) refs #7461 - fixing inline docs for nodelist (slightly). adopt and place pass through position to place(), which introduced only and replace (if i'm not mistaken). These may not be desireable. It is also worth expanding upon the behavior of dojo.place() when used with complex creation, and the end results of only and replace. but that can be covered in user docs.

comment:24 Changed 11 years ago by bill

[16336] was tacked onto this ticket, although the checkin was largely unrelated to documentation.

The (typeof tc.max == "number") type checks were actually just checking if tc defined a max attribute, and are best implemented using ("max" in tc), not isNaN(), since isNaN() is for testing whether or not values are numeric.

comment:25 Changed 11 years ago by Adam Peller

(In [16512]) Some inline doc improvements. Refs #7461 !strict

comment:26 Changed 11 years ago by Adam Peller

(In [16513]) Some inline doc improvements. Refs #7461 !strict

comment:27 Changed 11 years ago by dante

(In [16514]) refs #7461 - document the return value of .placeAt explicitly. !strict

comment:28 Changed 11 years ago by dante

(In [16547]) refs #7461 - micro doc update !strict

comment:29 Changed 11 years ago by bill

(In [16606]) various API doc updates for content and formatting, refs #7461 !strict.

comment:30 Changed 11 years ago by bill

(In [16607]) more API doc updates for content and formatting, refs #7461 !strict.

comment:31 Changed 11 years ago by bill

(In [16608]) dijit/_base API doc updates for content and formatting, refs #7461 !strict.

comment:32 Changed 11 years ago by bill

(In [16609]) dijit/form API doc updates for content and formatting, refs #7461 !strict.

comment:33 Changed 11 years ago by dante

(In [16610]) refs #7461 - adjust public functions to be exposed to api, and pseudo-doc the others. !strict

comment:34 Changed 11 years ago by bill

(In [16611]) dijit/layout API doc updates for content and formatting, refs #7461 !strict.

comment:35 Changed 11 years ago by bill

(In [16613]) dijit API doc updates for content and formatting, refs #7461 !strict.

comment:36 Changed 11 years ago by bill

(In [16614]) dijit/tree API doc updates for formatting, refs #7461 !strict.

comment:37 Changed 11 years ago by dante

Milestone: future1.3
Resolution: fixed
Status: newclosed

you've gone on long enough faithful #7461. We will be using #8606 for the remainder of 1.3.

comment:38 Changed 10 years ago by Adam Peller

(In [20065]) style changes, some code reductions. !strict Refs #7461

comment:39 Changed 10 years ago by bill

(In [20949]) Better documentation for NumberTextBox and CurrencyTextBox, specifically around the constraints parameter. Refs #7461 !strict.

comment:40 Changed 10 years ago by bill

(In [20950]) Better documentation for DateTextBox, specifically around the constraints parameter. Refs #7461 !strict.

Note: See TracTickets for help on using tickets.