2
0
Эх сурвалжийг харах

Merge pull request #4314 from markknol/patch-2

Xml documentation
Simon Krajewski 10 жил өмнө
parent
commit
93821fe0dc
1 өөрчлөгдсөн 54 нэмэгдсэн , 2 устгасан
  1. 54 2
      std/Xml.hx

+ 54 - 2
std/Xml.hx

@@ -19,27 +19,79 @@
  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  * DEALINGS IN THE SOFTWARE.
  */
-
+ 
+/**
+	Xml node types.
+**/
 @:enum abstract XmlType(Int) {
+	/**
+		Represents an XML element type.
+	**/
 	var Element = 0;
+	/**
+		Represents XML parsed character data type.
+	**/
 	var PCData = 1;
+	/**
+		Represents XML character data type.
+	**/
 	var CData = 2;
+	/**
+		Represents an XML comment type.
+	**/
 	var Comment = 3;
+	/**
+		Represents an XML doctype element type.
+	**/
 	var DocType = 4;
+	/**
+	 	Represents an XML processing instruction type.
+	**/
 	var ProcessingInstruction = 5;
+	/**
+		Represents an XML document type.
+	**/
 	var Document = 6;
 }
 
+/**
+	Crossplatform Xml API.
+	
+	@see http://haxe.org/manual/std-Xml.html
+**/
 class Xml {
-
+	/**
+		XML element type.
+	**/
 	static public var Element(default,null) = XmlType.Element;
+	/**
+		XML parsed character data type.
+	**/
 	static public var PCData(default,null) = XmlType.PCData;
+	/**
+		XML character data type.
+	**/
 	static public var CData(default,null) = XmlType.CData;
+	/**
+		XML comment type.
+	**/
 	static public var Comment(default,null) = XmlType.Comment;
+	/**
+		XML doctype element type.
+	**/
 	static public var DocType(default,null) = XmlType.DocType;
+	/**
+	 	XML processing instruction type.
+	**/
 	static public var ProcessingInstruction(default,null) = XmlType.ProcessingInstruction;
+	/**
+		XML document type.
+	**/
 	static public var Document(default,null) = XmlType.Document;
 
+	/**
+		Parses the String into an Xml document. 
+	**/
 	static public function parse( str : String ) : Xml {
 		return haxe.xml.Parser.parse(str);
 	}