PDA

View Full Version : RowExpander documentation pollution



WesleyMoy
13 Jul 2010, 6:20 PM
The Javadoc documentation for RowExpander contains an improperly-closed code tag. This causes pollution in both the RowExpander documentation page (http://www.sencha.com/deploy/gxtdocs/com/extjs/gxt/ui/client/widget/grid/RowExpander.html) and, more importantly, the index (http://www.sencha.com/deploy/gxtdocs/index-all.html). This makes for tiresome reading.

The code in question from RowExpander.java:


* A <code>ColumnConfig</li> subclass and a <code>ComponentPlgin</code> that
* adds the ability for each row to be expanded, showing custom content that
* spans all the rows columns.

GXT version: 2.1.1

WesleyMoy
23 Jul 2010, 1:12 PM
There are other locations where this is true:

- In ComboBox.setExpanded(boolean): There are two opening <code> tags (the second of which should be a closing tag)
- In ListStore: The first sentence of the documentation does not end in a period, resulting in unusual indentation in the JavaDoc Index

sven
23 Jul 2010, 1:29 PM
Thanks, we are going to look into it.

WesleyMoy
27 Jul 2010, 2:00 PM
I'll continue replying to this thread with other documentation issues if I find them.

- TextField, code snippet: The characters "&lt" should be "&lt;"

WesleyMoy
9 Aug 2010, 9:34 AM
ListStore:

An event is listed as "Store.DataChange". This should instead read "Store.DataChanged".

WesleyMoy
18 Aug 2010, 2:20 PM
The @deprecated text is incorrect for the following classes. When linking to a class, they use two @link annotations.

com.extjs.gxt.ui.client.binder.DataViewBinder
com.extjs.gxt.ui.client.widget.table.TableColumn
com.extjs.gxt.ui.client.widget.treetable.TreeTable
com.extjs.gxt.ui.client.binder.TreeTableBinder
com.extjs.gxt.ui.client.widget.treetable.TreeTableColumnModel
com.extjs.gxt.ui.client.widget.treetable.TreeTableHeader
com.extjs.gxt.ui.client.widget.treetable.TreeTableItem
com.extjs.gxt.ui.client.widget.treetable.TreeTableItemUI
com.extjs.gxt.ui.client.widget.treetable.TreeTableView

WesleyMoy
18 Aug 2010, 2:21 PM
For that matter, com.extjs.gxt.ui.client.event.DataListEvent has a different @deprecated when compared to other deprecated classes. It omits the word "see" before the linked class name.