[gxml/gsoc2013] Some documentation fixes
- From: Richard Hans Schwarting <rschwart src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gxml/gsoc2013] Some documentation fixes
- Date: Sun, 28 Jul 2013 05:32:09 +0000 (UTC)
commit e4dc48ddefafc06e5b195a9cc95be39ce00a88bc
Author: Richard Schwarting <aquarichy gmail com>
Date: Sun Jul 28 01:30:10 2013 -0400
Some documentation fixes
gxml/Attr.vala | 6 +++---
gxml/Document.vala | 6 +++---
gxml/Implementation.vala | 2 +-
gxml/Node.vala | 5 +++--
gxml/NodeList.vala | 3 ++-
5 files changed, 12 insertions(+), 10 deletions(-)
---
diff --git a/gxml/Attr.vala b/gxml/Attr.vala
index eed3f85..e69bbda 100644
--- a/gxml/Attr.vala
+++ b/gxml/Attr.vala
@@ -185,12 +185,12 @@ namespace GXml {
* underlying document. If the attribute is changed,
* it is set to false.
*
- * @todo: this requires support from the DTD, and
- * probably libxml2's xmlAttribute
- *
* Version: DOM Level 1 Core
* URL: [[http://www.w3.org/TR/REC-DOM-Level-1/level-one-core.html#ID-862529273]]
*/
+ /* @todo: this requires support from the DTD, and
+ * probably libxml2's xmlAttribute
+ */
public bool specified {
// STUB
get;
diff --git a/gxml/Document.vala b/gxml/Document.vala
index 6832782..e0623b5 100644
--- a/gxml/Document.vala
+++ b/gxml/Document.vala
@@ -498,7 +498,7 @@ namespace GXml {
/* Public Methods */
/**
* Creates an empty Element node with the tag name
- * tag_name, which must be a [[http://www.w3.org/TR/REC-xml/#NT-Name|valid XML name].
+ * tag_name, which must be a [[http://www.w3.org/TR/REC-xml/#NT-Name|valid XML name]].
*
* XML example: {{{<Person></Person>}}}
*
@@ -682,10 +682,10 @@ namespace GXml {
* only have one Element child, the root element, and
* one DocumentType.
*
- * @return The newly added child.
- *
* Version: DOM Level 1 Core
* URL: [[http://www.w3.org/TR/REC-DOM-Level-1/level-one-core.html#method-appendChild]]
+ *
+ * @return The newly added child.
*/
public override Node? append_child (Node new_child) {
this.check_wrong_document (new_child);
diff --git a/gxml/Implementation.vala b/gxml/Implementation.vala
index 43ee2b5..16714f2 100644
--- a/gxml/Implementation.vala
+++ b/gxml/Implementation.vala
@@ -102,7 +102,7 @@ namespace GXml {
* Reports whether we support a feature at a given version level.
*
* Version: DOM Level 1 Core
- * URL: http://www.w3.org/TR/REC-DOM-Level-1/level-one-core.html#method-hasFeature
+ * URL: [[http://www.w3.org/TR/REC-DOM-Level-1/level-one-core.html#method-hasFeature]]
*
* TODO: implement more of this, using libxml2's parser.h's xmlGetFeature, xmlHasFeature, etc.
*
diff --git a/gxml/Node.vala b/gxml/Node.vala
index 8da9c95..bbb2788 100644
--- a/gxml/Node.vala
+++ b/gxml/Node.vala
@@ -87,8 +87,8 @@ namespace GXml {
/**
* The list of attributes that store namespace definitions. This is not part of a DOM spec.
- * @TODO: determine best API for exposing these, as it's not defined in the IDL
*/
+ /* @TODO: determine best API for exposing these, as it's not defined in the IDL */
public virtual NodeList? namespace_definitions {
get {
return null;
@@ -221,7 +221,8 @@ namespace GXml {
*
* Version: DOM Level 1 Core
* URL: [[http://www.w3.org/TR/REC-DOM-Level-1/level-one-core.html#attribute-childNodes]]
- *
+ */
+ /*
* @todo: identify node types that use children for values, like attribute
*/
public virtual NodeList? child_nodes {
diff --git a/gxml/NodeList.vala b/gxml/NodeList.vala
index 1ef6a66..2303517 100644
--- a/gxml/NodeList.vala
+++ b/gxml/NodeList.vala
@@ -130,7 +130,8 @@ namespace GXml {
* @param in_line Whether to parse and expand entities or not.
*
* @return The list as an XML string.
- *
+ */
+ /*
* @todo: write a test
*/
public abstract string to_string (bool in_line);
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]