Documenting the XML format.

git-svn-id: svn://10.0.0.236/trunk@155113 18797224-902f-48f8-a5cc-f745e15eee43
2004-04-19 07:21:37 +00:00
parent d6fa086ad5
commit bd7f416095
1 changed files with 12 additions and 0 deletions
--- a/mozilla/extensions/sql/base/public/mozISqlResult.idl
+++ b/mozilla/extensions/sql/base/public/mozISqlResult.idl
@@ -147,6 +147,18 @@ interface mozISqlResult : nsISupports
  /**
   * Returns a stream which may be used to return the rows as XML.
   *
+   * The XML format is:
+   * <?xml version="1.0"?>
+   * <document>
+   *   <body>
+   *     <row>
+   *       <cell>value11</cell>
+   *       <cell>value12</cell>
+   *       ...
+   *     </row>
+   *   </body>
+   * </document>
+   *
   * @return               the input stream
   */
  mozISqlInputStream open();