[seed] [docs] Fix numerous gtk-doc warnings



commit 9c5c7ca039b69bf4dea73057452977ca98b27d2a
Author: Tim Horton <hortont424 gmail com>
Date:   Tue Jul 7 22:17:52 2009 -0400

    [docs] Fix numerous gtk-doc warnings

 doc/reference/tmpl/seed-jsclass.sgml     |    2 +-
 doc/reference/tmpl/seed-nativefuncs.sgml |    2 +-
 doc/reference/tmpl/seed-nativetypes.sgml |    2 +-
 libseed/seed-exceptions.c                |    4 +++-
 libseed/seed.h                           |    7 +++----
 5 files changed, 9 insertions(+), 8 deletions(-)
---
diff --git a/doc/reference/tmpl/seed-jsclass.sgml b/doc/reference/tmpl/seed-jsclass.sgml
index f0ab062..3fd7c61 100644
--- a/doc/reference/tmpl/seed-jsclass.sgml
+++ b/doc/reference/tmpl/seed-jsclass.sgml
@@ -64,7 +64,7 @@ Long description
 
 @ctx: 
 @class: 
- Param3: 
+ constructor: 
 @Returns: 
 
 
diff --git a/doc/reference/tmpl/seed-nativefuncs.sgml b/doc/reference/tmpl/seed-nativefuncs.sgml
index 22b8b7a..ecf9d18 100644
--- a/doc/reference/tmpl/seed-nativefuncs.sgml
+++ b/doc/reference/tmpl/seed-nativefuncs.sgml
@@ -37,7 +37,7 @@ Long description
 </para>
 
 @ctx: 
- callback: 
+ func: 
 @name: 
 @Returns: 
 
diff --git a/doc/reference/tmpl/seed-nativetypes.sgml b/doc/reference/tmpl/seed-nativetypes.sgml
index 97ac650..a12bac6 100644
--- a/doc/reference/tmpl/seed-nativetypes.sgml
+++ b/doc/reference/tmpl/seed-nativetypes.sgml
@@ -112,7 +112,7 @@ Long description
 </para>
 
 @ctx: 
- type: 
+ value: 
 @Returns: 
 
 
diff --git a/libseed/seed-exceptions.c b/libseed/seed-exceptions.c
index 341346f..54f2d74 100644
--- a/libseed/seed-exceptions.c
+++ b/libseed/seed-exceptions.c
@@ -24,7 +24,9 @@
  * @ctx: A #SeedContext.
  * @exception: A reference to a #SeedException in which to store the exception.
  * @name: The #gchar* representing the exception name.
- * @message: The #gchar* representing the details of the exception.
+ * @message: The #gchar*, as a printf format string, representing the
+ *           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.
  *
diff --git a/libseed/seed.h b/libseed/seed.h
index f3aa0a2..8f820a5 100644
--- a/libseed/seed.h
+++ b/libseed/seed.h
@@ -250,7 +250,7 @@ typedef SeedValue (*SeedFunctionCallback) (SeedContext ctx,
 void seed_create_function (SeedContext ctx,
 			   gchar * name, SeedFunctionCallback callback,
 			   SeedObject object);
-SeedObject seed_make_function (SeedContext ctx, SeedFunctionCallback callback, const gchar *name);
+SeedObject seed_make_function (SeedContext ctx, SeedFunctionCallback func, const gchar *name);
 /* Inconsistent naming? */
 SeedObject seed_make_array (SeedContext ctx, const SeedValue elements,
 			    gsize num_elements, SeedException *exception);
@@ -361,8 +361,7 @@ SeedClass seed_create_class (seed_class_definition * def);
 
 SeedObject seed_make_constructor (SeedContext ctx,
 				  SeedClass class,
-				  SeedObjectCallAsConstructorCallback
-				  constructor);
+				  SeedObjectCallAsConstructorCallback constructor);
 
 void seed_engine_set_search_path (SeedEngine * eng, const gchar * path);
 gchar **seed_engine_get_search_path (SeedEngine * eng);
@@ -389,7 +388,7 @@ void seed_importer_set_search_path (SeedContext ctx,
 
 void seed_prepare_global_context (SeedContext ctx);
 
-SeedType seed_value_get_type (SeedContext ctx, SeedValue type);
+SeedType seed_value_get_type (SeedContext ctx, SeedValue value);
 
 gchar **seed_object_copy_property_names(SeedContext ctx, SeedObject object);
 



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