Ticket #7461 (closed enhancement: fixed)

Opened 11 months ago

Last modified 5 months ago

[meta] clean up documentation

Reported by: pottedmeat Owned by:
Priority: high Milestone: 1.3
Component: Documentation Version: 1.1.1
Severity: normal Keywords:
Cc:

Description

Find and clean up any issues

Attachments

revision.diff (1.5 kB) - added by neonstalwart 8 months ago.
looks like order of params have swapped at some point and added ? to inline docs for optional params

Change History

Changed 11 months ago by pottedmeat

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

Changed 10 months ago by bill

  • summary changed from Clean up documentation to [meta] clean up documentation
  • milestone changed from 1.2 to future

Changed 10 months ago by dante

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

Changed 10 months ago by dante

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

Changed 10 months ago by toonetown

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

Changed 10 months ago by dante

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

Changed 10 months ago by dante

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

Changed 10 months ago by dante

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

Changed 10 months ago by bill

  • owner deleted
  • component changed from Doc parser to Documentation

Changed 10 months ago by dante

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

Changed 10 months ago by peller

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

Changed 10 months ago by dante

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

Changed 10 months ago by peller

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

Changed 10 months ago by peller

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

Changed 8 months ago by neonstalwart

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

Changed 8 months ago by dante

revision.diff applied in [15541] - thanks neonstalwart

Changed 7 months ago by peller

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

Changed 6 months ago by dante

add base/Color doc expansion in [16157]

Changed 6 months 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

Changed 6 months ago by dante

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

Changed 6 months ago by dante

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

Changed 6 months ago by dante

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

Changed 6 months 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)

Changed 6 months 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.

Changed 6 months 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.

Changed 5 months ago by peller

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

Changed 5 months ago by peller

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

Changed 5 months ago by dante

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

Changed 5 months ago by dante

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

Changed 5 months ago by bill

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

Changed 5 months ago by bill

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

Changed 5 months ago by bill

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

Changed 5 months ago by bill

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

Changed 5 months ago by dante

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

Changed 5 months ago by bill

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

Changed 5 months ago by bill

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

Changed 5 months ago by bill

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

Changed 5 months ago by dante

  • status changed from new to closed
  • resolution set to fixed
  • milestone changed from future to 1.3

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

Note: See TracTickets for help on using tickets.