[gxml] * add documentation for Comment
- From: Richard Hans Schwarting <rschwart src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gxml] * add documentation for Comment
- Date: Thu, 21 Jul 2011 19:47:41 +0000 (UTC)
commit 14daa84816c8a1afaea2c11dba7d29743f378182
Author: Richard Schwarting <aquarichy gmail com>
Date: Thu Jul 21 14:37:07 2011 -0400
* add documentation for Comment
gxml/Comment.vala | 8 ++++++++
1 files changed, 8 insertions(+), 0 deletions(-)
---
diff --git a/gxml/Comment.vala b/gxml/Comment.vala
index a2baf42..a743337 100644
--- a/gxml/Comment.vala
+++ b/gxml/Comment.vala
@@ -2,6 +2,14 @@
namespace GXml.Dom {
/* TODO: do we really want a comment node, or just use strings? */
+ /**
+ * An XML comment. An XML example looks like: {{{
+ * <someNode>
+ * <!-- this is a comment -->
+ * text in the node
+ * </someNode> }}}
+ * For more, see: [[http://www.w3.org/TR/DOM-Level-1/level-one-core.html#ID-1728279322]]
+ */
public class Comment : CharacterData {
// TODO: Can I make this only accessible from within the GXml.Dom namespace (e.g. from GXml.Dom.Document?)
internal Comment (Xml.Node *comment_node, Document doc) {
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]