[gxml] * add documentation for CDATASection



commit eae2ba95bdb623a54d4461645cc4fe96ad48a548
Author: Richard Schwarting <aquarichy gmail com>
Date:   Thu Jul 21 14:36:38 2011 -0400

    * add documentation for CDATASection

 gxml/CDATASection.vala |   10 ++++++++++
 1 files changed, 10 insertions(+), 0 deletions(-)
---
diff --git a/gxml/CDATASection.vala b/gxml/CDATASection.vala
index 98f471b..5268dac 100644
--- a/gxml/CDATASection.vala
+++ b/gxml/CDATASection.vala
@@ -3,10 +3,20 @@
 namespace GXml.Dom {
 	/* TODO: do we really want a cdata section node, or just use strings? */
 	/* TODO: check about casing in #vala */
+	/**
+	 * An XML CDATA section, which contains non-XML data that is
+	 * stored in an XML document. An XML example would be like:
+	 * {{{ <![CDATA[Here contains non-XML data, like code, or something that
+	 * requires a lot of special XML entities.]]>. }}}
+	 * It is a type of Text node. For more, see: [[http://www.w3.org/TR/DOM-Level-1/level-one-core.html#ID-667469212]]
+	 */
 	public class CDATASection : Text {
 		internal CDATASection (Xml.Node *cdata_node, Document doc) {
 			base (cdata_node, doc);
 		}
+		/**
+		 * { inheritDoc}
+		 */
 		public override string node_name {
 			get {
 				return "#cdata-section";



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]