That seems like the right thing.

On 2008-01-23, at 15:20 EST, Donald Anderson wrote:

Thanks the comments.

In the LzView class, there is a 'var layout;' with no javadoc.
Should I insert javadoc there to match the 3.4 documentation?

- Don

On Jan 23, 2008, at 2:55 PM, P T Withington wrote:

André is right about 'layout'. It was probably previously documented in the schema. It doesn't show up as an attribute in the LFC because the tag compiler deals with it. We need some way to document such things. So, either the doc is missing in the schema, or it is a tool bug that schema doc is not picked up.

Even though determinePlacement is used outside the LFC, I would vote to keep it private.

On 2008-01-23, at 14:14 EST, André Bargull wrote:

Some notes:
"LzNode#determinePlacement(..)" is also used outside of the LFC, see i.e. "basegridcolumn".

"LzView#layout" v.s. "LzView#layouts":
I thought "layout" is special-attribute for abbreviation, so let's say instead of:
<view>
<simplelayout axis="x" spacing="10" />
</view>
you just say: <view layout="axis:x; spacing:10" />.
And "layouts" is an array which contains all layouts of a view (a view may have several different layouts).

Summary: Set doc visibility for methods/events/attributes in LzNode, LzView

New Features:

Bugs Fixed: LPP-5011

Technical Reviewer: max (pending)
QA Reviewer: (pending)
Doc Reviewer: lou (pending)

Documentation: LzNode and LzView should be very close to 3.4 doc now.
 See details below.

Release Notes:

Details:
Attempted to do a side by side comparison of what was missing in 4.x
doc vs. 3.4 doc.  When discrepencies found, used 
http://wiki.openlaszlo.org/LFC_API_review
as a guide, if it wasn't specifically mentioned (like the many events in LzView), I added in the missing items. In only a few cases this means that there is now an item without doc, e.g. the 'onplay' event, which didn't have any
doc before.

There's a couple cases that probably need more clarification:

-  LzNode.determinePlacement - max says 'this still exists',
  I left it private because of this in the content:
Note that this function is not currently designed to be called by anyone but LzNode.construct....

- LzView.layout had doc in 3.4, in 4.1 there is a (new?) LzView.layouts attribute, but LzView.layout did not appear in the doc. It looks like 'layouts' is the preferred mechanism with layout now be used either internally? or for backward compatibility? I left LzView.layout to be unmarked (therefore private and not shown).


Tests:

Files:
M      WEB-INF/lps/lfc/core/LzNode.lzs
M      WEB-INF/lps/lfc/views/LaszloView.lzs

Changeset: http://svn.openlaszlo.org/openlaszlo/patches/20080123-dda-l.tar



--

Don Anderson
Java/C/C++, Berkeley DB, systems consultant

voice: 617-547-7881
email: [EMAIL PROTECTED]
www: http://www.ddanderson.com




--

Don Anderson
Java/C/C++, Berkeley DB, systems consultant

voice: 617-547-7881
email: [EMAIL PROTECTED]
www: http://www.ddanderson.com






Reply via email to