[seed] [docs] Add exception names to reference



commit e6b1696d22f915bf5098a7d21256f164f79f53d2
Author: Tim Horton <hortont424 gmail com>
Date:   Thu Jul 9 00:41:57 2009 -0400

    [docs] Add exception names to reference

 doc/reference/tmpl/seed-exception.sgml |   14 ++++++++++++--
 libseed/seed-exceptions.c              |    5 ++---
 libseed/seed-module.h                  |    3 ++-
 3 files changed, 16 insertions(+), 6 deletions(-)
---
diff --git a/doc/reference/tmpl/seed-exception.sgml b/doc/reference/tmpl/seed-exception.sgml
index eac4527..24ba385 100644
--- a/doc/reference/tmpl/seed-exception.sgml
+++ b/doc/reference/tmpl/seed-exception.sgml
@@ -5,10 +5,20 @@ Exception Handling
 Throwing and catching exceptions
 
 <!-- ##### SECTION Long_Description ##### -->
+<note>
+<title>Predefined Exception Names</title>
 <para>
-Long description
+<itemizedlist>
+  <listitem><emphasis>InvalidPropertyValue</emphasis> - a property was set to a value out of range</listitem>
+  <listitem><emphasis>PropertyError</emphasis> - a warning occurred in GLib while trying to set a property</listitem>
+  <listitem><emphasis>ArgumentError</emphasis> - a function was called with the wrong number of arguments</listitem>
+  <listitem><emphasis>ConversionError</emphasis> - one of the type conversion functions threw an exception</listitem>
+  <listitem><emphasis>TypeError</emphasis> - a required argument was of the wrong type</listitem>
+  <listitem><emphasis>SyntaxError</emphasis> - a syntax error was thrown from JavaScriptCore</listitem>
+  <listitem><emphasis>ParseError</emphasis> - a parsing error was thrown from JavaScriptCore (make sure you close all of your brackets!)</listitem>
+</itemizedlist>
 </para>
-
+</note>
 <!-- ##### SECTION See_Also ##### -->
 <para>
 
diff --git a/libseed/seed-exceptions.c b/libseed/seed-exceptions.c
index 54f2d74..998bef4 100644
--- a/libseed/seed-exceptions.c
+++ b/libseed/seed-exceptions.c
@@ -28,10 +28,9 @@
  *           details of the exception.
  * @VarArgs: A list of printf-style format arguments to substitute in @message.
  *
- * The line number and file name of the exception created will be undefined.
+ * Creates a new JavaScript exception with the given attributes.
  *
- * The runtime documentation contains a list of names of built-in exceptions,
- * and should eventually be merged in here.
+ * The line number and file name of the exception created will be undefined.
  *
  */
 void
diff --git a/libseed/seed-module.h b/libseed/seed-module.h
index ae64356..6eb1449 100644
--- a/libseed/seed-module.h
+++ b/libseed/seed-module.h
@@ -41,7 +41,8 @@
  * Defines a property on @holder which is named the same as @member, and
  * is assigned the value that @member has in C.
  *
- * This macro works for defining properties from constants and defines as well.
+ * This macro works for defining properties from constants and
+ * &num;defines as well.
  *
  */
 #define DEFINE_ENUM_MEMBER(holder, member) \



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