Show
Ignore:
Timestamp:
05/21/08 15:55:43 (5 years ago)
Author:
lyokato
Message:

lang/actionscript/as3atompub: improved document

Location:
lang/actionscript/as3atompub/src/org/coderepos/xml/atom
Files:
4 modified

Legend:

Unmodified
Added
Removed

  • lang/actionscript/as3atompub/src/org/coderepos/xml/atom/AtomCategories.as

    r11461 r12105  
    1515  import com.adobe.net.URI; 
    1616 
     17  /** 
     18   * Class represents atom categories 
     19   */ 
    1720  public class AtomCategories extends AtomElement { 
    1821 
     22    /** 
     23     * Constructor 
     24     * 
     25     * @param source 
     26     * @langversion ActionScript 3.0 
     27     * @playerversion 9.0 
     28     */ 
    1929    public function AtomCategories(source:XML=null) { 
    2030      super(source); 
    2131    } 
    2232 
     33    /** 
     34     * get element name 
     35     * 
     36     * @returns elementName 
     37     * @langversion ActionScript 3.0 
     38     * @playerversion 9.0 
     39     */ 
    2340    override public function get elementName():String { 
    2441      return "categories"; 
    2542    } 
    2643 
     44    /** 
     45     * get default namespace 
     46     * 
     47     * @returns namespace 
     48     * @langversion ActionScript 3.0 
     49     * @playerversion 9.0 
     50     */ 
    2751    override public function get defaultNamespace():Namespace { 
    2852      return AtomNamespace.APP_WITHOUT_PREFIX; 
    2953    } 
    3054 
     55    /** 
     56     * get categories, synonym of getCategories method 
     57     * 
     58     * @returns categories array 
     59     * @langversion ActionScript 3.0 
     60     * @playerversion 9.0 
     61     */ 
    3162    public function get categories():Array { 
    3263      return getCategories(); 
    3364    } 
    3465 
     66    /** 
     67     * get categories 
     68     * 
     69     * @returns categories array 
     70     * @langversion ActionScript 3.0 
     71     * @playerversion 9.0 
     72     */ 
    3573    public function getCategories():Array { 
    3674      var elementList:XMLList = getElementList(AtomNamespace.ATOM, "category"); 
    … …  
    4381    } 
    4482 
     83    /** 
     84     * set category, synonym of the setCategory 
     85     * 
     86     * @param category 
     87     * @langversion ActionScript 3.0 
     88     * @playerversion 9.0 
     89     */ 
    4590    public function set category(_category:AtomCategory):void { 
    4691      setCategory(_category); 
    4792    } 
    4893 
     94    /** 
     95     * set category 
     96     * 
     97     * @param categorie 
     98     * @langversion ActionScript 3.0 
     99     * @playerversion 9.0 
     100     */ 
    49101    public function setCategory(_category:AtomCategory):void { 
    50102      setAtomElement(AtomNamespace.ATOM, "category", _category); 
    51103    } 
    52104 
     105    /** 
     106     * add category 
     107     * 
     108     * @param categorie 
     109     * @langversion ActionScript 3.0 
     110     * @playerversion 9.0 
     111     */ 
    53112    public function addCategory(_category:AtomCategory):void { 
    54113      addAtomElement(AtomNamespace.ATOM, "category", _category); 
    55114    } 
    56115 
     116    /** 
     117     * get href uri, synonym of getHref method 
     118     * 
     119     * @returns href uri 
     120     * @langversion ActionScript 3.0 
     121     * @playerversion 9.0 
     122     */ 
    57123    public function get href():URI { 
    58124      return getHref(); 
    59125    } 
    60126 
     127    /** 
     128     * get href uri 
     129     * 
     130     * @returns href uri 
     131     * @langversion ActionScript 3.0 
     132     * @playerversion 9.0 
     133     */ 
    61134    public function getHref():URI { 
    62135      if (_src.hasOwnProperty("@href")) { 
    … …  
    67140    } 
    68141 
     142    /** 
     143     * set href uri, setHref 
     144     * 
     145     * @param href uri 
     146     * @langversion ActionScript 3.0 
     147     * @playerversion 9.0 
     148     */ 
    69149    public function set href(_href:URI):void { 
    70150      setHref(_href); 
    71151    } 
    72152 
     153    /** 
     154     * set href uri 
     155     * 
     156     * @param href uri 
     157     * @langversion ActionScript 3.0 
     158     * @playerversion 9.0 
     159     */ 
    73160    public function setHref(_href:URI):void { 
    74161      _src.@href = _href.toString(); 
    75162    } 
    76163 
     164    /** 
     165     * get scheme, synonym of getScheme method 
     166     * 
     167     * @returns scheme 
     168     * @langversion ActionScript 3.0 
     169     * @playerversion 9.0 
     170     */ 
    77171    public function get scheme():String { 
    78172      return getScheme(); 
    79173    } 
    80174 
     175    /** 
     176     * get scheme 
     177     * 
     178     * @returns scheme 
     179     * @langversion ActionScript 3.0 
     180     * @playerversion 9.0 
     181     */ 
    81182    public function getScheme():String { 
    82183      if (_src.hasOwnProperty("@scheme")) { 
    … …  
    87188    } 
    88189 
     190    /** 
     191     * set scheme, synonym of setScheme method 
     192     * 
     193     * @param scheme 
     194     * @langversion ActionScript 3.0 
     195     * @playerversion 9.0 
     196     */ 
    89197    public function set scheme(_scheme:String):void { 
    90198      setScheme(_scheme); 
    91199    } 
    92200 
     201    /** 
     202     * set scheme 
     203     * 
     204     * @param scheme 
     205     * @langversion ActionScript 3.0 
     206     * @playerversion 9.0 
     207     */ 
    93208    public function setScheme(_scheme:String):void { 
    94209      _src.@scheme = _scheme; 
    95210    } 
    96211 
     212    /** 
     213     * get boolean that shows if it fixed or not 
     214     * synonym of getFixed method 
     215     * 
     216     * @returns boolean that shows fixed or not 
     217     * @langversion ActionScript 3.0 
     218     * @playerversion 9.0 
     219     */ 
    97220    public function get fixed():Boolean { 
    98221      return getFixed(); 
    99222    } 
    100223 
     224    /** 
     225     * get boolean that shows if it fixed or not 
     226     * 
     227     * @returns boolean that shows fixed or not 
     228     * @langversion ActionScript 3.0 
     229     * @playerversion 9.0 
     230     */ 
    101231    public function getFixed():Boolean { 
    102232      if (_src.hasOwnProperty("@fixed")) { 
    … …  
    107237    } 
    108238 
     239    /** 
     240     * set boolean that shows if it fixed or not 
     241     * synonym of setFixed method 
     242     * 
     243     * @param boolean that shows fixed or not 
     244     * @langversion ActionScript 3.0 
     245     * @playerversion 9.0 
     246     */ 
    109247    public function set fixed(_fixed:Boolean):void { 
    110248      setFixed(_fixed); 
    111249    } 
    112250 
     251    /** 
     252     * set boolean that shows if it fixed or not 
     253     * 
     254     * @param boolean that shows fixed or not 
     255     * @langversion ActionScript 3.0 
     256     * @playerversion 9.0 
     257     */ 
    113258    public function setFixed(_fixed:Boolean):void { 
    114259      if (_fixed) { 

  • lang/actionscript/as3atompub/src/org/coderepos/xml/atom/AtomCategory.as

    r11461 r12105  
    1313package org.coderepos.xml.atom { 
    1414 
     15  /** 
     16   * Class represents atom category 
     17   */ 
    1518  public class AtomCategory extends AtomElement { 
    1619 
     20    /** 
     21     * Constructor 
     22     * 
     23     * @param source XML object 
     24     * @langversion ActionScript 3.0 
     25     * @playerversion 9.0 
     26     */ 
    1727    public function AtomCategory(source:XML=null) { 
    1828      super(source); 
    1929    } 
    2030 
     31    /** 
     32     * get element name 
     33     * 
     34     * @returns elementName 
     35     * @langversion ActionScript 3.0 
     36     * @playerversion 9.0 
     37     */ 
    2138    override public function get elementName():String { 
    2239      return "category"; 
    2340    } 
    2441 
     42    /** 
     43     * get term, synonym of getTerm method 
     44     * 
     45     * @returns term 
     46     * @langversion ActionScript 3.0 
     47     * @playerversion 9.0 
     48     */ 
    2549    public function get term():String { 
    2650      return getTerm(); 
    2751    } 
    2852 
     53    /** 
     54     * get term 
     55     * 
     56     * @returns term 
     57     * @langversion ActionScript 3.0 
     58     * @playerversion 9.0 
     59     */ 
    2960    public function getTerm():String { 
    3061      if (_src.hasOwnProperty("@term")) { 
    … …  
    3566    } 
    3667 
     68    /** 
     69     * set term, synonym of setTerm method 
     70     * 
     71     * @param term 
     72     * @langversion ActionScript 3.0 
     73     * @playerversion 9.0 
     74     */ 
    3775    public function set term(_term:String):void { 
    3876      setTerm(_term); 
    3977    } 
    4078 
     79    /** 
     80     * set term 
     81     * 
     82     * @param term 
     83     * @langversion ActionScript 3.0 
     84     * @playerversion 9.0 
     85     */ 
    4186    public function setTerm(_term:String):void { 
    4287      _src.@term = _term; 
    4388    } 
    4489 
     90    /** 
     91     * get label, synonym of getLabel method 
     92     * 
     93     * @returns label 
     94     * @langversion ActionScript 3.0 
     95     * @playerversion 9.0 
     96     */ 
    4597    public function get label():String { 
    4698      return getLabel(); 
    4799    } 
    48100 
     101    /** 
     102     * get label 
     103     * 
     104     * @returns label 
     105     * @langversion ActionScript 3.0 
     106     * @playerversion 9.0 
     107     */ 
    49108    public function getLabel():String { 
    50109      if (_src.hasOwnProperty("@label")) { 
    … …  
    55114    } 
    56115 
     116    /** 
     117     * set label, synonym of setLabel method 
     118     * 
     119     * @param label 
     120     * @langversion ActionScript 3.0 
     121     * @playerversion 9.0 
     122     */ 
    57123    public function set label(_label:String):void { 
    58124      return setLabel(_label); 
    59125    } 
    60126 
     127    /** 
     128     * set label 
     129     * 
     130     * @param label 
     131     * @langversion ActionScript 3.0 
     132     * @playerversion 9.0 
     133     */ 
    61134    public function setLabel(_label:String):void { 
    62135      _src.@label = _label; 
    63136    } 
    64137 
     138    /** 
     139     * get scheme, synonym of getScheme method 
     140     * 
     141     * @returns scheme 
     142     * @langversion ActionScript 3.0 
     143     * @playerversion 9.0 
     144     */ 
    65145    public function get scheme():String { 
    66146      return getScheme(); 
    67147    } 
    68148 
     149    /** 
     150     * get scheme 
     151     * 
     152     * @returns scheme 
     153     * @langversion ActionScript 3.0 
     154     * @playerversion 9.0 
     155     */ 
    69156    public function getScheme():String { 
    70157      if (_src.hasOwnProperty("@scheme")) { 
    … …  
    75162    } 
    76163 
     164    /** 
     165     * set scheme, synonym of setScehem method 
     166     * 
     167     * @param scheme 
     168     * @langversion ActionScript 3.0 
     169     * @playerversion 9.0 
     170     */ 
    77171    public function set scheme(_scheme:String):void { 
    78172      setScheme(_scheme); 
    79173    } 
    80174 
     175    /** 
     176     * set scheme 
     177     * 
     178     * @param scheme 
     179     * @langversion ActionScript 3.0 
     180     * @playerversion 9.0 
     181     */ 
    81182    public function setScheme(_scheme:String):void { 
    82183      _src.@scheme = _scheme; 

  • lang/actionscript/as3atompub/src/org/coderepos/xml/atom/AtomControl.as

    r11461 r12105  
    4747 
    4848} 
     49 

  • lang/actionscript/as3atompub/src/org/coderepos/xml/atom/AtomNamespace.as

    r11461 r12105  
    1313package org.coderepos.xml.atom { 
    1414 
     15  /** 
     16   * Class stores namespaces that used in atompub protocols often. 
     17   */ 
    1518  public class AtomNamespace { 
    1619 
     20    /** 
     21     * atom namespace with prefix 
     22     */ 
    1723    public static const ATOM:Namespace = new Namespace('atom', 'http://www.w3.org/2005/Atom'); 
     24    /** 
     25     * atom namespace without prefix 
     26     */ 
    1827    public static const ATOM_WITHOUT_PREFIX:Namespace = new Namespace('http://www.w3.org/2005/Atom'); 
     28    /** 
     29     * app namespace with prefix 
     30     */ 
    1931    public static const APP:Namespace = new Namespace('app', 'http://www.w3.org/2007/app'); 
     32    /** 
     33     * app namespace without prefix 
     34     */ 
    2035    public static const APP_WITHOUT_PREFIX:Namespace = new Namespace('http://www.w3.org/2007/app'); 
     36    /** 
     37     * open search namespace 
     38     */ 
    2139    public static const OPEN_SEARCH:Namespace = new Namespace('openSearch', 'http://a9.com/-/spec/opensearchrss/1.1/'); 
     40    /** 
     41     * dubline core namespace 
     42     */ 
    2243    public static const DC:Namespace = new Namespace('dc', 'http://purl.org/dc/elements/1.1/'); 
     44    /** 
     45     * friend of a friend namespace 
     46     */ 
    2347    public static const FOAF:Namespace = new Namespace('foaf', 'http://xmlns.com/foaf/0.1'); 
     48    /** 
     49     * atom threading namespace 
     50     */ 
    2451    public static const THR:Namespace = new Namespace('thr', 'http://purl.org/syndication/thread/1.0'); 
    2552