[Laszlo-dev] [Laszlo-checkins] r9117 - openlaszlo/trunk/WEB-INF/lps/lfc/data

[P T Withington]

We don't still need the "DEFINE OBJECT:" tag do we?

On 2008-05-13, at 14:48 EDT, hqm at openlaszlo.org wrote:

> Author: hqm
> Date: 2008-05-13 11:48:28 -0700 (Tue, 13 May 2008)
> New Revision: 9117
>
> Modified:
>   openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataElement.lzs
>   openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataNode.lzs
>   openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataText.lzs
> Log:
> Change 20080513-hqm-e by hqm at badtzmaru.home on 2008-05-13 14:19:36 EDT
>    in /Users/hqm/openlaszlo/trunk4
>    for http://svn.openlaszlo.org/openlaszlo/trunk
>
> Summary:  update documentation
>
> New Features:
>
> Bugs Fixed: LPP-5594
>
> Technical Reviewer: amy
> QA Reviewer: (pending)
> Doc Reviewer: (pending)
>
> Documentation:
>
> Release Notes:
>
> Details:
>
>
> Tests:
>
>
>
> Modified: openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataElement.lzs
> ===================================================================
> --- openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataElement.lzs	 
> 2008-05-13 17:41:22 UTC (rev 9116)
> +++ openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataElement.lzs	 
> 2008-05-13 18:48:28 UTC (rev 9117)
> @@ -572,9 +572,15 @@
>   */
> class LzDataElement extends LzDataNode with LzDataElementMixin,  
> LzDataNodeMixin
> {
> -    // N.B.: LzDataElement is not an LzNode so has a different
> -    // initialize signature.
> +    /** DEFINE OBJECT: LzDataElement
> +     * This object represents a hierarchical data node.
> +     * @param String name: The name for this node.
> +     * @param Object attributes: A optional dictionary of  
> attributes for this node.
> +     * @param [LzDataNode] children: An optional array of children  
> for this node
> +     */
>     function LzDataElement ( name , attributes = null, children =  
> null) {
> +        // N.B.: LzDataElement is not an LzNode so has a different
> +        // initialize signature.
>             super(attributes, children);
>             this.nodeName = name;
>             this.nodeType = LzDataElement.ELEMENT_NODE;
>
> Modified: openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataNode.lzs
> ===================================================================
> --- openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataNode.lzs	2008-05-13  
> 17:41:22 UTC (rev 9116)
> +++ openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataNode.lzs	2008-05-13  
> 18:48:28 UTC (rev 9117)
> @@ -55,8 +55,8 @@
>   * </example>
>   *
>   * @shortdesc The base class for a node of hierarchical data.
> -  * @devnote LzDataNode is the abstract baseclass for LzDataElement  
> and LzDataText.
> -  * N.B.: LzDataNode may or may not be an LzNode, so _if_ it were
> +  * @devnote LzDataNodeMixin is the abstract baseclass for  
> LzDataElement and LzDataText.
> +  * N.B.: LzDataNodeMixin may or may not be an LzNode, so _if_ it  
> were
>   * to have an initialize method, it would have to match
>   * LzNode.initialize's signature.
>   *
> @@ -208,20 +208,36 @@
> // Only static methods and variables remain here
>
> /**
> - *  @access private
> + * @topic LFC
> + * @subtopic Data
> + *
> + * @shortdesc The base class for a node of hierarchical data.
> + *
> + * <p> LzDataNode is deprecated, all methods and constants have  
> been moved to <link linkend="LzDataElement">LzDataElement</link></p>
> + *
> + * @access public
> + * @deprecated Use <code>LzDataElement.ELEMENT_NODE</code> instead.  
> The methods and constants in this class are deprecated
> + *
>  */
> class LzDataNode extends  LzEventable {
>
> +
> +/**
> +  * @access private
> +  */
>     function LzDataNode ( attributes = null, children = null) {
>         super();
>     }
>
>
> -// @deprecated Use <code>LzDataElement.ELEMENT_NODE</code> instead
> +/** @deprecated Use <code>LzDataElement.ELEMENT_NODE</code> instead
> + */
> static var ELEMENT_NODE = 1;
> -// @deprecated Use <code>LzDataElement.TEXT_NODE</code> instead
> +/** @deprecated Use <code>LzDataElement.TEXT_NODE</code> instead
> + */
> static var TEXT_NODE = 3;
> -// @deprecated Use <code>LzDataElement.DOCUMENT_NODE</code> instead
> +/** @deprecated Use <code>LzDataElement.DOCUMENT_NODE</code> instead
> + */
> static var DOCUMENT_NODE = 9;
>
>
>
> Modified: openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataText.lzs
> ===================================================================
> --- openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataText.lzs	2008-05-13  
> 17:41:22 UTC (rev 9116)
> +++ openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataText.lzs	2008-05-13  
> 18:48:28 UTC (rev 9117)
> @@ -19,8 +19,9 @@
> class LzDataText extends LzDataNode with LzDataNodeMixin {
>
> /**
> -  * @param String text: The text that this node holds.
> -  */
> + * This object represents a text node in a set of data.
> + * @param String text: The text that this node holds.
> + */
> function LzDataText ( text ){
>     super();
>     this.nodeType = LzDataElement.TEXT_NODE;
>
>
> _______________________________________________
> Laszlo-checkins mailing list
> Laszlo-checkins at openlaszlo.org
> http://www.openlaszlo.org/mailman/listinfo/laszlo-checkins