[1.1.1] Ext.data.DataReader not documented

[GArrow]

There is no documentation-browser-friendly documentation for the DataReader class. Someone has to look at the DataReader.js source code.

Suggested documentation:


/**
* @class Ext.data.DataReader
*
* Abstract base class for reading structured data from a data source and converting
* it into an object containing {@link Ext.data.Record} objects and metadata for use
* by an {@link Ext.data.Store}. This class is intended to be extended and should not
* be created directly. (See ArrayReader, JsonReader and XmlReader).
*
* @constructor Create a new DataReader
* @param {Object} meta Metadata configuration options.
* @param {Object} recordType Either an Array of field definition objects as specified
* to {@link Ext.data.Record#create}, or an {@link Ext.data.Record} object created
* using {@link Ext.data.Record#create}.
*/

[GArrow]

Ok, I just noticed the sticky-thread about documentation issues and the comment in there to the effect that this is not-documented on purpose, because no one is supposed to instantiate one of these.

Reconsider this!

This would be like having all abstract Java or .NET classes be undocumented, with developers told "Go find the source code and read it, and you'll be told this is abstract!". Surely it makes sense to have documentation telling people not to use something directly, instead of leaving them to wonder "Why isnt this documented?" and to question the quality of Ext for it. (Which was my reaction at the time.)

[jsakalos]

Have you re-posted it in the sticky "incorrect doc" thread? If not, please do so.

[GArrow]

Done. Thanks.