PDA

View Full Version : [Closed] Missing and/or Incorrect Docs - Ext 1.1 (beta1)+



tryanDLS
4 Jun 2007, 7:31 AM
I've closed the previous bugs thread on this topic and started a new one. Since numerous doc bugs have been reported and fixed and there's some new functionality, let's restrict new reports to the 1.1 download. Also, since it's still beta and some of the new functionality hasn't been doc'd, please don't report those - we'll be working on that as we go.

efege
4 Jun 2007, 7:37 AM
Thanks Tim. I'll begin reporting my findings soon.

For reference, this is a link to the previous (now closed) thread (http://extjs.com/forum/showthread.php?t=5350).

efege
4 Jun 2007, 8:45 AM
Ok, I'll begin.

First, some general suggestions, not specific to this release.

* When browsing the docs, it would be very nice to highlight the currently active tree node. Of course, this has to take into account that the active node changes not only through node-clicking on the left panel, but also through link-clicking on the right panel.

* The "up arrow" icon used to rapidly identify inherited methods/properties in the brief descriptions would be very useful if present also on detailed descriptions (for doing rapid doc scanning).

* References to classes/methods in the descriptions of classes/methods are not always displayed as links (@link in source), though these links are always useful. Should we report those links that are missing? (There are possibly lots of them.)

* Add this declaration to the stylesheet:


.label { vertical-align: top; }

The attached images show why it is needed.

* Suggested changes on the welcome.html page:

- If you need help, it's only a click away: Help Forums. [shouldn't we also mention here the #extjs channel?]

- The most common classes => Some of the most common classes


That's all for now.

efege
4 Jun 2007, 9:54 AM
Class Ext
* class description: utilties => utilities
* method apply: there's an extra * before "Copies".


Class Ext.data.ArrayReader
* ArrayReader constructor: fix links (problem with two @link's on the same line?)

Class Ext.data.Connection
* There are some external URLs (W3C specs), and they are not links. Should URLs be displayed as links? (This is a general question, btw.)

Class Ext.data.JsonReader
* Remove period: Example code:.

Class Ext.data.Node
* Class lacks a description
* Interates => Iterates
* method nextSibling (resp. previousSibling): text says null if there is no sibling node; it should be more precisely expressed as: null if there is no next (resp. previous) sibling node.

Class Ext.data.Record
* Add comma in description: an Array of field definition objects to create, and instances

Class Ext.data.ScriptTagProxy
* javascript source code => Capitalize JS
* Below is a Java example: example not seen (surce has <pre><code. instead of <pre><code>)
* The url from which => The URL from which (I'm assuming the acronym URL is always used in capitals)

Class Ext.data.SimpleStore
* Description: help class or helper class?
* Config option id: The index in the array that be used for record ids <- doesn't sound ok

Class Ext.data.SortTypes
* Class lacks a description

Class Ext.data.Tree
* Returns this root node for this tree => Returns the root node for this tree

Class Ext.data.XmlReader
* Add end period: set to "text/xml"
* Remove end period: Example code:.

Animal
4 Jun 2007, 11:36 AM
OK. I've had a go at the Ext.data classes that I know about.

Of course I can't test the results, so we'll have to wait until the next drop of the docs.

efege
4 Jun 2007, 11:48 AM
Hi Animal,

I'm organizing the info following the classes as they appear on the Doc Center. Would you prefer if I posted also the js source file name?

Animal
4 Jun 2007, 11:53 AM
It doesn't matter. I know where to find most of the classes.

I'll have a go at Node and Tree tomorrow.

efege
4 Jun 2007, 2:25 PM
Class Ext.dd.DD
* property scroll: wehn => when
* constructor: an object containing configurable attributes Valid properties for DD: scroll <= needs at least a period before "Valid" (this probably also happens in other constructor's descriptions)
* method cachePosition: missing {int} in source for iPageX, iPageY

Class Ext.dd.DragDrop
* remove one "that": items that that can be dragged
* Up to three html elements => Up to three HTML elements
* there's a list (linked element, handle element(s), drag element) that should be more clearly displayed as a list (bullets), or at least highlight the 3 element types
* method isTarget: insances => instances
* method onDragEnter: fist begins => first begins
* method removeFromGroup: Remove's this instance => Removes this instance

Class Ext.dd.DragDropMgr
* method getStyle: element style property => element's style property
* method isLegalTarget: fix parameters data types
* method isLegalTarget: the specifice drag obj => the specified drag object
* method isTypeOfDD: My goal is to be able ... <= 1st person doc? ;)
* method refreshCache: @TODO (how should "@TODO" comments be displayed?)
* method startDrag: threshol => threshold

Class Ext.dd.DragZone
* method getDragData: remove extra * before "Called"

Class Ext.dd.DropTarget
* methods notifyEnter, notifyOver: there's a visible @link

Class Ext.dd.DropZone
* several visible @link

Class Ext.dd.Registry
* method register: spaces are not preserved in the Value/Description table

Class Ext.dd.StatusProxy
* methods getEl, getGhost: return value "el" seems too brief a description


EDIT: hey, this my post #100, I'll have a break now ;-)

sjivan
4 Jun 2007, 6:29 PM
- docs for GridView missing.

- PagingToolbar config option 'displayInfo' missing

- docs for Ext.grid.PropertyGrid missing

efege
5 Jun 2007, 5:03 AM
Class Ext.form.BasicForm
* methods applyIfToFields, applyToFields: for all field in this form => for all fields in this form
* method getValues: with key value pair => with key/value pairs
* method isValid: Returns true is => Returns true if
* method render: attribute and call applyTo => attribute, and calls applyTo
* methods errorReader, reader: add closing parenthesis after XmlReader
* methods errorReader, reader: when is something "completely optional" ? :)
* config timeout: lacks description
* config trackResetOnLoad: fix instead of the when the form was first created
* config url: url to use => URL to use

Class Ext.form.Column
* config width: data type is said to be Number, but "auto" is not Number :-/

Class Ext.form.ComboBox
* method doQuery: The sql query => The SQL query
* method getValue: currently-selected => currently selected
* method selectByValue: remove valueFound from return value description? valueFound True if the value matched an item in the list, else false
* event beforequery: are those {braces} supposed to be there?
* config transform: element => Element

efege
5 Jun 2007, 5:42 AM
Class Ext.form.DateField
* method getValue: remove the first "value" from the return value description
* config altFormats: Multiple date formats separated by/to try => Multiple date formats separated by "|" to try
* config invalidText: The error to display => The error text to display
* config maxText: the date in the cell is before maxValue => the date in the cell is after maxValue
* In the default maxText & minText, the words "before" and "after" are used as if the date was not allowed to coincide with the max/min value.

Class Ext.form.Field
* method applyTo: DOM Node => DOM node
* method initComponent: description is not displayed
* method isDirty: has ben => has been
* method reset: originally-loaded => originally loaded
* config inputType: remove period after "password". Replace "-" with "--".
* config msgFx: list of possible values?
* config msgTarget: table is not ok
* config readOnly: this is not very clear: Note: this only sets the readOnly attribute.
* config validateOnBlur: suggested description: "True to validate this field on blur. Defaults to true". Also, check data type (String/Boolean)
* config validationEvent: remove period after "validation"
* event change: check parameters (value, value)

Class Ext.form.Form
* Class description: with JS => with JavaScript
* property buttons: add a @link to "addButton"
* methods column, container, fieldset: Opens the a new
* config minButtonWidth: mention the unit (pixels)
* config monitorValid: monitors it's valid state => monitors its valid state

Class Ext.form.HtmlEditor
* Class description: FireFox => Firefox
* property buttonTips: For Example => For example
* method cleanHtml: check the return value description (return {String} The cleaned html ... Returns: void)
* method cleanHtml: The cleaned html => The cleaned HTML

Class Ext.form.Layout
* config style: eg => , e.g.
* A question: why is a config property "style" needed, instead of using a css class?

Ext.form.NumberField
* config allowNegative: "False to require only positive numbers" (where does zero fall?)

Class Ext.form.TextArea
* config autoSize: "This only takes effect if grow = true and fires the autosize event." <= needs a comma before "and"?

Class Ext.form.TextField
* config autoSize: "This only takes effect if grow = true and fires the autosize event." <= needs a comma before "and"?

Class Ext.form.VTypes
* Class description: Overrideable => Overridable [http://www.googlefight.com/index.php?word1=Overrideable&word2=Overridable] ;)
* method url: The function used to validate urls => The function used to validate URLs

Herm
5 Jun 2007, 7:06 AM
On this page, http://extjs.com/deploy/ext-1.1-beta1/docs/output/Ext.data.ScriptTagProxy.html the Ext.data.ScriptTagProxy refers to example this is missing. It says "Below is a Java example for a servlet" but there is none.

Cheers,
Peter

efege
5 Jun 2007, 7:14 AM
Hi Herm, this was already posted in message #4 of this thread (http://extjs.com/forum/showthread.php?p=36575#post36575) :)

efege
6 Jun 2007, 5:19 AM
Class Ext.grid.AbstractSelectionModel
* class lacks description
* method lock: Lock the selections => Locks the selections
* method unlock: Unlock the selections => Unlocks the selections

Class Ext.grid.CellSelectionModel
* class lacks description
* method hasSelection: Returns True => Returns true (this capitalization differences probably don't matter at all, right?)

Class Ext.grid.ColumnModel
* prop defaultWidth, methods getColumnWidth, getTotalWidth, setColumnWidth, event widthchange: mention unit (pixels) (config width does it!)
* method getColumnId: remove extra * before "Returns"
* method getColumnsBy: "Returns: Array result" ?
* method getRenderer: fix {@link #setRenderer}
* method setRenderer: do the parameters to the render function have names?
* event columlockchange: should it be called columnlockchange? (note the missing "n")

Class Ext.grid.EditorGrid
* class description: Class for creating and editable grid => Class for creating an editable grid
* method startEditing: fix description "Starts editing the specified for the specified row/column"
* events afteredit, beforeedit, validateedit: I think the event object properties should be listed below "An edit event", instead of above. (Also note that the phrase "The edit event object has the following properties" is absent in one of the descriptions)

Class Ext.grid.Grid
* Common Problems: suggestion, use <li> for the list items
* prop ddText: "Configures the text is the drag proxy" => "Configures the text in the drag proxy" (?)
* method render: remove extra * before "Called"
* events dragdrop, dragenter, dragout, dragover: The target drag drop object => The target drag drop object's id (or The id of the target drag drop object)
* curiosity: events names use enter/out (instead of enter/leave or in/out)
* method dragover: is it ok the reference to Yahoo.util.DD ?
* config autoExpandColumn: String with default false?
* config autoExpandMax, autoExpandMin, maxHeight, minColumnWidth: mention unit (pixels)
* config maxRowsToMeasure: Boolean number of rows?
* config maxRowsToMeasure: a columns size => a column's size
* config view: add @link to "render"

Class Ext.grid.RowSelectionModel
* methods deselectRange, selectRange: why the word "also"?
* method selectLastRow: Select the last row => Selects the last row in the grid.
* method selectRows: row to select => rows to select
* event beforerowselect: fix "a row is selected being selected"

jay@moduscreate.com
6 Jun 2007, 10:02 AM
http://extjs.com/deploy/ext/docs/output/Ext.QuickTips.html#configs




//QuickTips.js Lines 294 - 309

register : function(config){
var cs = config instanceof Array ? config : arguments;
for(var i = 0, len = cs.length; i < len; i++) {
var c = cs[i];
var target = c.target;
if(target){
if(target instanceof Array){
for(var j = 0, jlen = target.length; j < jlen; j++){
tagEls[target[j]] = c;
}
}else{
tagEls[typeof target == 'string' ? target : Ext.id(target.id)] = c;
}
}
}
},

efege
6 Jun 2007, 1:25 PM
Hi djliquidice, just a clarification.

Though in this particular case it doesn't make a difference, we should be checking (and linking to) the 1.1b1 docs:

http://extjs.com/deploy/ext-1.1-beta1/docs/output/Ext.QuickTips.html#configs

tryanDLS
6 Jun 2007, 6:18 PM
Class Ext.form.DateField
* method getValue: remove the first "value" from the return value description
* config altFormats: Multiple date formats separated by/to try => Multiple date formats separated by "|" to try
* config invalidText: The error to display => The error text to display
* config maxText: the date in the cell is before maxValue => the date in the cell is after maxValue
* In the default maxText & minText, the words "before" and "after" are used as if the date was not allowed to coincide with the max/min value.

Class Ext.form.Form
* Class description: with JS => with JavaScript
* property buttons: add a @link to "addButton"
* methods column, container, fieldset: Opens the a new
* config minButtonWidth: mention the unit (pixels)
* config monitorValid: monitors it's valid state => monitors its valid state

Class Ext.form.Field
* method applyTo: DOM Node => DOM node
* method initComponent: description is not displayed
* method isDirty: has ben => has been
* method reset: originally-loaded => originally loaded
* config inputType: remove period after "password". Replace "-" with "--".
* config msgFx: list of possible values?
* config msgTarget: table is not ok
* config readOnly: this is not very clear: Note: this only sets the readOnly attribute.
* config validateOnBlur: suggested description: "True to validate this field on blur. Defaults to true". Also, check data type (String/Boolean)
* config validationEvent: remove period after "validation"
* event change: check parameters (value, value)

Class Ext.form.HtmlEditor
* Class description: FireFox => Firefox
* property buttonTips: For Example => For example
* method cleanHtml: check the return value description (return {String} The cleaned html ... Returns: void)
* method cleanHtml: The cleaned html => The cleaned HTML

Class Ext.form.Layout
* config style: eg => , e.g.
* A question: why is a config property "style" needed, instead of using a css class?

Ext.form.NumberField
* config allowNegative: "False to require only positive numbers" (where does zero fall?)

Class Ext.form.TextArea
* config autoSize: "This only takes effect if grow = true and fires the autosize event." <= needs a comma before "and"?

Class Ext.form.TextField
* config autoSize: "This only takes effect if grow = true and fires the autosize event." <= needs a comma before "and"?

Class Ext.form.VTypes
* Class description: Overrideable => Overridable [http://www.googlefight.com/index.php...d2=Overridable]
* method url: The function used to validate urls => The function used to validate URLs

Done except for msgFx, msgTarget. initComponent marked private for now.
NumberField.allowNegative only determines whether a "-" can be entered. Desc changed to reflect.

tryanDLS
6 Jun 2007, 7:32 PM
Class Ext.form.BasicForm
* methods applyIfToFields, applyToFields: for all field in this form => for all fields in this form
* method getValues: with key value pair => with key/value pairs
* method isValid: Returns true is => Returns true if
* method render: attribute and call applyTo => attribute, and calls applyTo
* methods errorReader, reader: add closing parenthesis after XmlReader
* methods errorReader, reader: when is something "completely optional" ? :)
* config timeout: lacks description
* config trackResetOnLoad: fix instead of the when the form was first created
* config url: url to use => URL to use

Class Ext.form.Column
* config width: data type is said to be Number, but "auto" is not Number :-/

Class Ext.form.ComboBox
* method doQuery: The sql query => The SQL query
* method getValue: currently-selected => currently selected
* method selectByValue: remove valueFound from return value description? valueFound True if the value matched an item in the list, else false
* event beforequery: are those {braces} supposed to be there?
* config transform: element => Element

Fixed

efege
6 Jun 2007, 9:00 PM
Class Ext.menu.ColorMenu
* event select: add description (Fires when ...)

Class Ext.menu.DateItem
* class description: Ext.DatPicker => Ext.DatePicker

Class Ext.menu.DateMenu
* event select: add description (Fires when ...)

Class Ext.menu.Menu
* class description: "to which you add all other menu items" <= seems that "other" can be removed
* class description: serve a as a base => serve as a base
* class description: specialzed => specialized
* method add: Addds => Adds
* method add: suggestion, use <li> for the 4-item list
* method addMenuItem: based an the supplied => based on the supplied
* method isVisible: "Read-only" method?
* config defaultAlign, config subMenuAlign: fix @link

Class Ext.menu.Separator
* class description: in you call => in your call

rtannert2
7 Jun 2007, 2:57 AM
Not a bug, just a suggestion: I think it's time to shorten the description of Ext.namespace() from

Creates namespaces but does not assume YAHOO is the root.

to

Creates namespaces.

efege
7 Jun 2007, 8:09 AM
Class Ext.state.CookieProvider
* class description: (suggestion) which saves state => which saves the application state
* class description: (suggestion) add a link to the "cookie spec" http://wp.netscape.com/newsref/std/cookie_spec.html or perhaps http://en.wikipedia.org/wiki/HTTP_cookie
* config domain: add commas: defaults to null, which uses the same domain the page is running on, including the 'www' like 'www.extjs.com'

Class Ext.state.Manager
* example in class description: add @link to Ext.BasicDialog



Class Ext.tree.AsyncTreeNode
* add a class description
* prop loader: remove extra * before "The"
* method reload: Trigger => Triggers
* config loader: add @link to TreeLoader

Class Ext.tree.DefaultSelectionModel
* class description: The default single selection => The default single selection model (?)
* methods selectNext, selectPrevious: both say "Selects the node above"
* event beforeselect: two parameters with same name (node)

Class Ext.tree.MultiSelectionModel
* class description: Multi selection => Multi selection model (?)

Class Ext.tree.TreeEditor
* config maxWidth: (suggestion) can "for you" be removed from "automatically limited for you"?

Class Ext.tree.TreeLoader
* class description: javascript => Javascript or JavaScript
* class description: who's elements => whose elements
* class description: ". eg" => ", e.g."
* class description: remove extra "<" before "This would pass"
* method load: "false.)" => "false)."
* event beforeload: "Json" => "JSON"
* config clearOnLoad: "Default to true. Remove previously existing child nodes before loading." => "Remove previously existing child nodes before loading (defaults to true)"
* config dataUrl: "Json" => "JSON", "an array of node definition object" => "an array of node definition objects"
* config uiProviders: fix "this that string value"

Class Ext.tree.TreeNode
* add class description

Class Ext.tree.TreePanel
* add a class description
* methods expandPath, selectPath: "where bSuccess is if the expand was successful" => "where bSuccess is true if the expand was successful". BTW, bSuccess, oLastNode is not the usual notation in Ext docs.
* method getEl: fix "Returns: void"
* method getLoader: fix "Returns: void"
* method getSelectionModel: fix "Returns: void"
* event beforecollapse: Add descriptions for deep and anim.
* event beforeexpand: Add descriptions for deep and anim.
* events beforenodedrop, nodedragover, nodedrop: use <li> for the list of properties. Suggestion: move the list of properties below "Subscribers will be called..."
* event disabledchange: add description for the "disabled" parameter
* events dragdrop, enddrag, startdrag: "The raw browser event" => "The raw mouse event" (as in other instances of "raw" on this page)
* config ddScroll: "YUI body scrolling" ?
* config dragConfig: broken @link to Ext.tree.TreeDragZone
* config dropConfig: broken @link to Ext.tree.TreeDropZone
* config hlColor: defaults to C3DAF9 => defaults to "C3DAF9" (add quotes, since it's a String)
* config loader: Boolean? Add @link to TreeLoader
* config selModel: Boolean?
* config singleExpand: defaults to...?

Class Ext.tree.TreeSorter
* config dir: (asc or desc) (defaults to asc) => ("asc" or "desc") (defaults to "asc")
* config folderSort: defaults to...?
* config property: defaults to text => defaults to "text"


TreeNodeUI docs are missing, and some @link's to TreeNodeUI docs should be present in the docs for Ext.tree.AsyncTreeNode, Ext.tree.TreeNode, Ext.tree.TreeLoader

efege
8 Jun 2007, 5:44 AM
Class Ext.util.CSS
* method createStyleSheet: "The text will wrapped" => "The text will be wrapped"
* method createStyleSheet: style or STYLE? HEAD or head?
* method getRule: "Gets an an"
* method getRule: "The first selector that is found is returned." => "The rule for the first selector that is found is returned."
* method getRules: all css rules => all CSS rules
* method swapStyleSheet: The href of the new stylesheet => The URL of the new stylesheet
* method updateRule: true If => true if

Class Ext.util.ClickRepeater
* preventDefault and stopDefault? shouldn't it be preventDefault and stopEvent instead?

Class Ext.util.JSON
* Douglas Crockford"s => Douglas Crockford's
* doesn"t => doesn't
* can you make the URL a live link?

Class Ext.util.MixedCollection
* method clone: add description for returned value, e.g. "The created collection"
* method containsKey: an "Object" is mentioned twice, but the parameter is a String.
* method each: returning false => Returning false
* method eachKey: "each key, and its associated item" <= remove comma
* method filter: "a RegExp to test against the property" => "a RegExp to test against the property values"
* method filterBy: remove extra "*" before "Returns".
* method filterBy: move the comma: "If the function returns true the value is included, otherwise it is filtered."
* method get: "associated with the passed key" => "associated with the passed key or index"
* method getKey: "o {Object}" => "Object o". Check formatting.
* method getRange: "default to the last item" => "defaults to the last item"
* method remove: "Removed an item" => "Removes an item"
* method removeAt: "in the collection" => "from the collection"
* method removeKey: "Removed an item" => "Removes an item"; "fom the collection" => "from the collection"
* method removeKey: returns an Object, not void (?)
* method replace: fix "o {Object}"
* event replace: "he key" => "The key"

Class Ext.util.Observable
* vertical-align for labels (see my previous post (http://extjs.com/forum/showthread.php?p=36557#post36557))
* "Subclasses are expected to to have" => "Subclasses are expected to have"
* Suggestion: add a JS comment to the example code, such as this: "// Define Employee, a subclass of Observable"
* methods Observable.capture, removeListener, un: The scope (this object) => The scope ("this" object)
* method addEvents: "The object with the events defined" <= please add a description of this object. The example at the top of the page shows this syntax: "eventName" : true, but what does that boolean mean?
* method addListener: join this two sentences: 'The scope in which to execute the handler function. The handler function's "this" context.' For example: 'The scope in which to execute the handler function, i.e. the handler function's "this" context.' Do the same some lines below, in the description of the "scope" option, and also in the description of method on.
* method addListener: remove braces in display of data types (e.g. "scope {Object}")
* method addListener: in the examples, the line "Code:" before the code is not necessary. The block beginning with "Attaching multiple handlers in 1 call" has an extra indentation. The example for "multiple handlers in 1 call" could be displayed in multiple lines for easier reading.
* method fireEvent: add a comma before "otherwise it returns true"
* method on: refer to addListener for the description of the options object.

Class Ext.util.TextMetrics
* methods bind, createInstance, measure: String/HTMLElement (missing Ext.Element?)
* method createInstance: "Return a unique" => "Returns a unique"
* methods createInstance, measure, setFixedWidth: mention unit (pixels?)
* method createInstance: check the return value (is "Ext.util.TextMetrics.Instance" ok?)
* method getHeight: "height The height in pixels" => "The height in pixels"
* method getWidth: "width The width in pixels" => "The width in pixels"

efege
8 Jun 2007, 7:41 PM
General suggestion, for all classes that have a constructor with config options:
add a @link from "Configuration options" (in the config parameter) to the "Config Options" section of the same page.


Class Ext.Ajax
* All properties: remove extra "*" at the beginning
* property method: The default HTTP method to be used => The default HTTP method to be used, i.e. "GET" or "POST"
* method serializeForm: form is only of type String/HTMLElement?
* method serializeForm: Add description for returned value.

Class Ext.BasicDialog
* Lightweight Dialog Class => Lightweight dialog class
* property body: "The body element" => "The dialog's body element"
* property buttons: add @link for "addButton"
* property footer: "The footer element" => "The dialog's footer element"
* property header: "The header element" => "The dialog's header element"
* method anchorTo: is the description ok? compare with alignTo
* method destroy: optional "removeEl" defaults to...?
* method getEl: "Returns the element" => "Returns the Ext.Element"
* method getTabs: "Returns the TabPanel component" => "Returns the TabPanel component for this dialog" (?)
* method moveTo: where is (0,0) ?
* method resizeTo: mention unit (pixels)
* method restoreState: add @link to "Ext.state" (?)
* method setContentSize: I do not find the description clear enough
* method setDefaultButton: "to be focused when the dialog is displayed" => "to be focused when the dialog is displayed (or focused)"
* method toFront: make description analogous to that of toBack: "Brings this dialog to the front (above) of any other visible dialogs"
* event keydown: "Fires when a key is pressed" ... and the dialog is active/focused (?)
* event resize: mention unit (pixels)
* config animateTarget: "String/Element" => "String/Ext.Element"
* config animateTarget: "while opening" => "while opening or closing"
* config buttonAlign: prepend something like "The alignment for this dialog's buttons"
* config minButtonWidth, minHeight, minWidth: specify units
* config tabTag: "The tag name" => "The HTML tag"

sjivan
9 Jun 2007, 3:14 PM
The headerdblclick event of Grid states that rowIndex is passed as a parameter. According the this thread the rowIndex should be removed from the docs.

http://extjs.com/forum/showthread.php?p=38051#post38051


headerdblclick
public event headerdblclick
Fires when a header cell is double clicked
Subscribers will be called with the following parameters:

* this : Grid
* rowIndex : Number
* columnIndex : Number
* e : Ext.EventObject

efege
10 Jun 2007, 11:01 AM
Class Ext.BasicLayoutRegion
* "move dom nodes" => "move DOM nodes"
* method add: "Add the passed ContentPanel(s)" => "Add the passed ContentPanel(s) to the region"
* method add: returns "The panel added (if only one was added)" ... otherwise returns null
* method getEl: "Returns the container Ext.Element for this region."
* methods getPanel, hasPanel, remove, showPanel: "the panels index" => "the panel's index"
* method getPosition: "this regions" => "this region's"
* method resizeTo: specify units
* event beforeremove: "The cancel event object" <= meaning what exactly?
* events beforeremove. collapsed, expanded, invalidated, panelactivated, paneladded, panelremoved, resized, slidehide, slideshow, visibilitychange: "this : Ext.LayoutRegion" => "this : Ext.BasicLayoutRegion"
* event resized: specify units for newSize
* event visibilitychange: for the description of visibility (Boolean) do not write "true or false" ;-) Better: "True if shown, false if hidden"

Class Ext.BorderLayout
* class description: "an absolute positioned element" => "an absolutely positioned element" or "an element with 'position:absolute'"
* constructor: "String/HTMLElement/Element" => "String/HTMLElement/Ext.Element"
* methods add, addRegion, remove: add quotes to the keys? ("north", "south", "east", "west" or "center")
* method addRegion: "regions config object" => "region's config object"
* method addRegion: returned value data type: BorderLayoutRegion => BasicLayoutRegion (?)
* method remove: "to this layout" => "from this layout"
* method restoreState: "layouts state" => "layout's state"
* method showPanel: "panels id" => "panel's id"

Class Ext.Button
* constructor: "String/HTMLElement/Element" => "String/HTMLElement/Ext.Element"
* method getEl: "underlying element" => "underlying Ext.Element"
* method toggle: "pressed state otherwise" => "pressed state, otherwise"
* config minWidth: specify unit
* config pressed: defaults to...

efege
10 Jun 2007, 11:12 AM
Class Ext.Component
* properties disabled, hidden, rendered: "Object" => "Boolean"
* property disabledClass: "Object" => "String"
* method getEl: "Returns the underlying Ext.Element" => "Returns the underlying Ext.Element for this component"
* method isVisible: returns Boolean, not void
* method render: "String/HTMLElement/Element" => "String/HTMLElement/Ext.Element"
* config hideMode: defaults to display => defaults to "display"

Class Ext.ComponentMgr
* method onAvailable: Funtction => Function

Class Ext.CompositeElement
* "Creates a Ext.Element" => "Creates an Ext.Element"
* suggestion: introduce the sample code with something like "Example"
* sample code: what's "getEls"?

Class Ext.CompositeElementLite
* class description: include at least one @link to Ext.Element. Perhaps also a link to Wikipedia's article on the Flyweight pattern?
* method each: "require a a reference" => "require a reference"; "the dom node" => "the DOM node"
* method item: could the phrase "a flyweight Element of the dom element object" be made a bit more clear?
* method item: "the dom element" => "the DOM element"

Class Ext.ContentPanel
* constructor: "String/HTMLElement/Element" => "String/HTMLElement/Ext.Element"
* method getEl: "this panel's element" => "this panel's Ext.Element"
* method getToolbar: "for this Panel" => "for this panel"
* method getUpdateManager: "panel. Enables you to perform Ajax updates." => "panel, which enables you to perform Ajax updates."
* methods load, setUrl: in all description texts, replace "url" with "URL".
* method load: add commas: "The URL for this request, or a function to call to get the URL, or a config object"
* method load: add indentation in the code sample
* method load: "on this panel UpdateManager" => "on this panel's UpdateManager"
* method setContent: is it "Updates this panel's element" or "Updates this panel's content" ?
* event deactivate: fix "Fires when this panel is activated."
* method resize: specify units
* config autoCreate: add @link to DomHelper.
* config closable, loadOnce: "defaults to..."
* config loadOnce: remove initial "Calls"
* config resizeEl: "Element" => "Ext.Element"
* config toolbar: "Toolbar" => "Ext.Toolbar"

Eric Suen
11 Jun 2007, 11:23 PM
* @param {String/HTMLElement/Element) el
should be
* @param {String/HTMLElement/Element} el

Eric Suen
12 Jun 2007, 12:35 AM
Element.wrap

* @return {/HTMLElementElement} The newly created wrapper element

Should be

* @return {HTMLElement/Element} The newly created wrapper element

cesarulo
12 Jun 2007, 12:46 PM
Hey,

I just reported this fact in the help forum, here (http://extjs.com/forum/showthread.php?t=7625).

tyranDLS indicates that this is the right place to report the problem, so I'm following his indications. Thanks,

Eric Suen
12 Jun 2007, 8:09 PM
Ext.DomHelper
all method has returnElement parameter has wrong return type in JSDoc

* @return {HTMLElement} The new node

Should be

* @return {HTMLElement/Ext.Element} The new node

efege
13 Jun 2007, 4:24 AM
Class Ext.DatePicker
* suggestion: include in the class description some general mention of localization support for all configs involving text (and date format)
* config cancelText: default text is "Cancel"
* config dayNames: add @link to Date.dayNames
* config hideMode: "should hidden" => "should hide" or "should be hidden"
* config hideMode: defaults to display => defaults to "display". Also, replace "css" with "CSS".
* config maxDate, minDate: "JavaScript date object" => "JavaScript Date object"
* config monthNames: add @link to Date.monthNames

Class Ext.DialogManager
* class description: add @link to Ext.BasicDialog. Add comma before "and support".
* all methods that return an Ext.BasicDialog: replace in the returned value "this" with "The dialog"

Class Ext.DomHelper
* general: replace "Dom" or "dom" in text descriptions with "DOM". Also replace "html" with "HTML".
* class description: suggestion: link to the blog post using its title (as is done in Ext.BorderLayout.html): "DomHelper - Create Elements using DOM, HTML fragments and Templates"
* property useDom: "html" => "HTML"
* method append: "String/HTMLElement/Element" => "String/HTMLElement/Ext.Element"; "a Ext.Element" => "an Ext.Element"
* methods append, insertAfter, insertBefore, insertFirst, overwrite: returned value has type HTMLElement or Ext.Element (depending on optional param returnElement) [Note: already reported by Eric Suen in previous post]
* method applyStyles: "Applies a style specification to an element" => "Applies a CSS style specification to an element"; "eg" => ", e.g."
* method createTemplate: add @link to Ext.DomHelper.Template; "Dom" => "DOM" (twice)
* method insertAfter: missing "or raw HTML blob" (compare with insertBefore)
* method insertHtml: add quotes to strings: "beforeBegin", "afterBegin", "beforeEnd", "afterEnd".
* method insertHtml: "fragmenet" => "fragment"

Class Ext.DomQuery
* remove initial "*"; replace "xpath" with "XPath"
* "a content node is passed in" => "a context node is passed in" ?
* "simple selectors" are mentioned several times... but what are they exactly?
* "an element that is has a checked attribute" => "an element that has a checked attribute"
* property operators: "as long as the match the format" => "as long as they match the format"
* property pseudos, method compile: there's some text in italics; fix here: "where <i>c<i> is any character" => "where <i>c</i> is any character"
* method selectNumber: add something about defaultValue, e.g. as in selectValue: "optionally replacing null with the defaultValue."
* method selectValue: fix "Returns: void"

mystix
14 Jun 2007, 12:12 AM
Class Ext.BorderLayout
* missing doc for convenience method create in 1.0.1a / 1.1b1

cchiriac
15 Jun 2007, 2:19 AM
Class Ext.BasicDialog
* config x : => The default left page coordinate of the dialog (defaults to center screen)
* config y : => The default top page coordinate of the dialog (defaults to center screen)

mystix
15 Jun 2007, 3:29 AM
Class Ext.Grid.RowSelectionModel
* missing event rowdeselect : => rowdeselect : (SelectionModel this, Number rowIndex)
* event rowselect : rowselect : (SelectionModel this, Number rowIndex) => rowselect : (SelectionModel this, Number rowIndex, Record r)
* event beforerowselect : beforerowselect : (SelectionModel this, Number rowIndex) => beforerowselect : (SelectionModel this, Number rowIndex, Boolean keepExisting)

GArrow
15 Jun 2007, 7:58 AM
Class Ext.Editor

The first parameter to the constructor has no @param.

cchiriac
15 Jun 2007, 8:07 AM
Class Ext.grid.ColumnModel
* event hiddenchange : (ColumnModel this, Number columnIndex, Number hidden) => (ColumnModel this, Number columnIndex, boolean hidden)

tryanDLS
15 Jun 2007, 1:14 PM
Ext.getDom
* @param {String/HTMLElement/Element) el
should be
* @param {String/HTMLElement/Element} el

Ext.DomHelper
all method has returnElement parameter has wrong return type in JSDoc
* @return {HTMLElement} The new node

Should be
* @return {HTMLElement/Ext.Element} The new node

The headerdblclick event of Grid states that rowIndex is passed as a parameter. According the this thread the rowIndex should be removed from the docs.

Class Ext.BasicDialog
* config x : => The default left page coordinate of the dialog (defaults to center screen)
* config y : => The default top page coordinate of the dialog (defaults to center screen)

Class Ext.Editor
* The first parameter to the constructor has no @param.

Class Ext.grid.ColumnModel
* event hiddenchange: (ColumnModel this, Number columnIndex, Number hidden) => (ColumnModel this, Number columnIndex, boolean hidden)

Class Ext.Grid.RowSelectionModel
* missing event rowdeselect : => rowdeselect : (SelectionModel this, Number rowIndex)
* event rowselect : rowselect : (SelectionModel this, Number rowIndex) => rowselect : (SelectionModel this, Number rowIndex, Record r)
* event beforerowselect : beforerowselect : (SelectionModel this, Number rowIndex) => beforerowselect : (SelectionModel this, Number rowIndex, Boolean keepExisting)


Fixed

Eric Suen
16 Jun 2007, 7:30 PM
Ext.data.Record
* @link Ext.data.Store} => missing {

tmk
17 Jun 2007, 3:40 AM
class Ext.data.HttpProxy
From Ext 1.1 beta this class uses Ext.Ajax (singleton) unless given an Ext.data.Connection object in the constructor. This should be noted in the docs as using multiple grids produces errors (http://extjs.com/forum/showthread.php?p=39583).

mystix
19 Jun 2007, 12:43 AM
Class Ext.grid.ColumnModel
* missing config option align : => align: String
(Optional) Sets CSS text-align property for the column

jschwartz73
20 Jun 2007, 11:38 AM
Minor bug in the XmlReader documentation.

The "occupation" tag below is closed with the "name" tag.

See below

<?xml?>
<dataset>
<results>2</results>
<row>
<id>1</id>
<name>Bill</name>
<occupation>Gardener</name>
</row>
<row>
<id>2</id>
<name>Ben</name>
<occupation>Horticulturalist</name>
</row>
</dataset>

tryanDLS
21 Jun 2007, 4:35 PM
class Ext.data.HttpProxy
From Ext 1.1 beta this class uses Ext.Ajax (singleton) unless given an Ext.data.Connection object in the constructor. This should be noted in the docs as using multiple grids produces errors (http://extjs.com/forum/showthread.php?p=39583).
Fixed. Note the referenced error was a bug in autoAbort



Ext.data.Record
* @link Ext.data.Store} => missing {

Minor bug in the XmlReader documentation.
The "occupation" tag below is closed with the "name" tag.

Fixed

tryanDLS
21 Jun 2007, 5:01 PM
Class Ext.grid.ColumnModel
* missing config option align : => align: String
(Optional) Sets CSS text-align property for the column

I don't see this used anywhere.

mystix
21 Jun 2007, 6:09 PM
I don't see this used anywhere.

discovered it by accident. i just stuffed an align:'center' config into the ColumnModel and it worked.

gaku
25 Jun 2007, 12:51 AM
Ext.Editor class

There's updateEl member in this class, and the source code says it is 'private'. However, it looks like a config parameter and there's no code in this class to change the value. Should this documented as @cfg?

Thanks,
-gaku

tryanDLS
25 Jun 2007, 9:39 AM
Class Ext.grid.ColumnModel
* missing config option align : => align: String
(Optional) Sets CSS text-align property for the column


Ext.Editor class
There's updateEl member in this class, and the source code says it is 'private'. However, it looks like a config parameter and there's no code in this class to change the value. Should this documented as @cfg?
Updated both as public config

sjivan
27 Jun 2007, 2:11 PM
Menu events 'click', 'mouseover ' and 'mouseout' have callbacks arguments that return the actual menuitem object and not the menuItemId String as documented.

I also often get callbacks for 'mouseover' and 'mouseover' with null passed for in this callback argument (presently menuItemId but should be menuItem) so might help if its documented that the user should check for null values for this. Is this supposed to be when the user mouseover's a region of the menu that doesn't have a menu item? Or is it a bug?

Also would it be possible to update the docs on the Ext site? Or are you waiting for the next release to update it?

Thanks,
Sanjiv

matjaz
29 Jun 2007, 3:08 AM
constrain method is defined in Number class, indexOf() and remove() in Array.
In docs they're all in String class.
This is probably documentation generator bug, caused by Ext.applyIf(Class.prototype).