GNOME.org
 

[gnome-video-arcade] Final preparations for 0.6.7.

commit bc80bf094e5344372c713e852e5964209a72ceee
Author: Matthew Barnes <mbarnes redhat com>
Date:   Sun Apr 26 18:40:28 2009 -0400

    Final preparations for 0.6.7.
    
    2009-04-26  Matthew Barnes  <mbarnes redhat com>
    
    	* NEWS: Update for 0.6.7
    
    	* docs/reference:
    	Update developer documentation.
    
    	* src/gva-input-file.c:
    	Document the new functions.
---
 ChangeLog                                      |   10 ++
 NEWS                                           |   12 ++-
 docs/reference/gnome-video-arcade-docs.sgml    |    1 +
 docs/reference/gnome-video-arcade-sections.txt |   25 +++++
 docs/reference/gnome-video-arcade.types        |    2 +
 docs/reference/tmpl/gva-input-file.sgml        |  124 ++++++++++++++++++++++++
 src/gva-game-store.c                           |    2 +-
 src/gva-input-file.c                           |   70 +++++++++++++
 8 files changed, 244 insertions(+), 2 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index bf571ab..1e31133 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,13 @@
+2009-04-26  Matthew Barnes  <mbarnes redhat com>
+
+	* NEWS: Update for 0.6.7
+
+	* docs/reference:
+	Update developer documentation.
+
+	* src/gva-input-file.c:
+	Document the new functions.
+
 2009-04-13  Matthew Barnes  <mbarnes redhat com>
 
 	* configure.ac:
diff --git a/NEWS b/NEWS
index bbfcc88..6c2f6f0 100644
--- a/NEWS
+++ b/NEWS
@@ -1,7 +1,7 @@
 GNOME Video Arcade 0.6.7
 ========================
 
-        Released April ??, 2009
+        Released April 26, 2009
 
         What's New
         ----------
@@ -11,6 +11,16 @@ GNOME Video Arcade 0.6.7
         * Set the GVA_DEBUG environment variable to "inp" to show
           input file header information.
 
+        User Interface Translations
+        ---------------------------
+        * Complete German translation by Mario Blättermann
+        * Complete Swedish translation by Daniel Nylander
+
+        Documentation Translations
+        --------------------------
+        * Partial German translation by Mario Blättermann
+        * Partial Swedish translation by Daniel Nylander
+
 GNOME Video Arcade 0.6.6
 ========================
 
diff --git a/docs/reference/gnome-video-arcade-docs.sgml b/docs/reference/gnome-video-arcade-docs.sgml
index 8d3c33d..29ad358 100644
--- a/docs/reference/gnome-video-arcade-docs.sgml
+++ b/docs/reference/gnome-video-arcade-docs.sgml
@@ -39,6 +39,7 @@
     <xi:include href="xml/gva-cell-renderer-pixbuf.xml"/>
     <xi:include href="xml/gva-column-manager.xml"/>
     <xi:include href="xml/gva-game-store.xml"/>
+    <xi:include href="xml/gva-input-file.xml"/>
     <xi:include href="xml/gva-link-button.xml"/>
     <xi:include href="xml/gva-mame-process.xml"/>
     <xi:include href="xml/gva-mute-button.xml"/>
diff --git a/docs/reference/gnome-video-arcade-sections.txt b/docs/reference/gnome-video-arcade-sections.txt
index 66cad10..3c9ebc7 100644
--- a/docs/reference/gnome-video-arcade-sections.txt
+++ b/docs/reference/gnome-video-arcade-sections.txt
@@ -125,6 +125,31 @@ gva_game_store_get_type
 </SECTION>
 
 <SECTION>
+<FILE>gva-input-file</FILE>
+<TITLE>GvaInputFile</TITLE>
+GvaInputFile
+gva_input_file_new
+gva_input_file_read
+gva_input_file_play_back
+gva_input_file_get_filename
+gva_input_file_get_format
+gva_input_file_get_game
+gva_input_file_get_origin
+gva_input_file_get_timestamp
+<SUBSECTION Standard>
+GVA_INPUT_FILE
+GVA_IS_INPUT_FILE
+GVA_TYPE_INPUT_FILE
+GVA_INPUT_FILE_CLASS
+GVA_IS_INPUT_FILE_CLASS
+GVA_INPUT_FILE_GET_CLASS
+GvaInputFileClass
+<SUBSECTION Private>
+GvaInputFilePrivate
+gva_input_file_get_type
+</SECTION>
+
+<SECTION>
 <FILE>gva-link-button</FILE>
 <TITLE>GvaLinkButton</TITLE>
 GvaLinkButton
diff --git a/docs/reference/gnome-video-arcade.types b/docs/reference/gnome-video-arcade.types
index 16e0326..1a62282 100644
--- a/docs/reference/gnome-video-arcade.types
+++ b/docs/reference/gnome-video-arcade.types
@@ -1,6 +1,7 @@
 #include <gva-cell-renderer-pixbuf.h>
 #include <gva-column-manager.h>
 #include <gva-game-store.h>
+#include <gva-input-file.h>
 #include <gva-link-button.h>
 #include <gva-mame-process.h>
 #include <gva-mute-button.h>
@@ -10,6 +11,7 @@
 gva_cell_renderer_pixbuf_get_type
 gva_column_manager_get_type
 gva_game_store_get_type
+gva_input_file_get_type
 gva_link_button_get_type
 gva_mame_process_get_type
 gva_mute_button_get_type
diff --git a/docs/reference/tmpl/gva-input-file.sgml b/docs/reference/tmpl/gva-input-file.sgml
new file mode 100644
index 0000000..f5db168
--- /dev/null
+++ b/docs/reference/tmpl/gva-input-file.sgml
@@ -0,0 +1,124 @@
+<!-- ##### SECTION Title ##### -->
+GvaInputFile
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### STRUCT GvaInputFile ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### ARG GvaInputFile:filename ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GvaInputFile:format ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GvaInputFile:game ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GvaInputFile:origin ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GvaInputFile:timestamp ##### -->
+<para>
+
+</para>
+
+<!-- ##### FUNCTION gva_input_file_new ##### -->
+<para>
+
+</para>
+
+ filename: 
+ Returns: 
+
+
+<!-- ##### FUNCTION gva_input_file_read ##### -->
+<para>
+
+</para>
+
+ input_file: 
+ error: 
+ Returns: 
+
+
+<!-- ##### FUNCTION gva_input_file_play_back ##### -->
+<para>
+
+</para>
+
+ input_file: 
+ error: 
+ Returns: 
+
+
+<!-- ##### FUNCTION gva_input_file_get_filename ##### -->
+<para>
+
+</para>
+
+ input_file: 
+ Returns: 
+
+
+<!-- ##### FUNCTION gva_input_file_get_format ##### -->
+<para>
+
+</para>
+
+ input_file: 
+ Returns: 
+
+
+<!-- ##### FUNCTION gva_input_file_get_game ##### -->
+<para>
+
+</para>
+
+ input_file: 
+ Returns: 
+
+
+<!-- ##### FUNCTION gva_input_file_get_origin ##### -->
+<para>
+
+</para>
+
+ input_file: 
+ Returns: 
+
+
+<!-- ##### FUNCTION gva_input_file_get_timestamp ##### -->
+<para>
+
+</para>
+
+ input_file: 
+ Returns: 
+
+
diff --git a/src/gva-game-store.c b/src/gva-game-store.c
index e3fb7e0..61f5dc9 100644
--- a/src/gva-game-store.c
+++ b/src/gva-game-store.c
@@ -251,7 +251,7 @@ gva_game_store_new (void)
 /**
  * gva_game_store_new_from_query:
  * @sql: an SQL query
- * @error: return locations for a #GError, or %NULL
+ * @error: return location for a #GError, or %NULL
  *
  * This may be the most powerful function in
  * <emphasis>GNOME Video Arcade</emphasis>.
diff --git a/src/gva-input-file.c b/src/gva-input-file.c
index 4b521e7..cbbbd0b 100644
--- a/src/gva-input-file.c
+++ b/src/gva-input-file.c
@@ -460,6 +460,14 @@ gva_input_file_get_type (void)
         return type;
 }
 
+/**
+ * gva_input_file_new:
+ * @filename: path to a MAME INP file
+ *
+ * Creates a new #GvaInputFile for the given @filename.
+ *
+ * Returns: a new #GvaInputFile
+ **/
 GvaInputFile *
 gva_input_file_new (const gchar *filename)
 {
@@ -468,6 +476,17 @@ gva_input_file_new (const gchar *filename)
         return g_object_new (GVA_TYPE_INPUT_FILE, "filename", filename, NULL);
 }
 
+/**
+ * gva_input_file_read:
+ * @input_file: a #GvaInputFile
+ * @error: return location for a #GError, or %NULL
+ *
+ * Reads header information from a MAME INP file.  The information is
+ * made available through the various accessor functions.  If an error
+ * occurs while reading, the function returns %FALSE and sets @error.
+ *
+ * Returns: %TRUE on success, %FALSE if an error occurred
+ **/
 gboolean
 gva_input_file_read (GvaInputFile *input_file,
                      GError **error)
@@ -524,6 +543,16 @@ exit:
         return success;
 }
 
+/**
+ * gva_input_file_play_back:
+ * @input_file: a #GvaInputFile
+ * @error: return location for a #GError, or %NULL
+ *
+ * Begins play back of @input_file and returns the resulting #GvaProcess.
+ * If an error occurs, it returns %NULL and sets @error.
+ *
+ * Returns: a new #GvaProcess, or %NULL
+ **/
 GvaProcess *
 gva_input_file_play_back (GvaInputFile *input_file,
                           GError **error)
@@ -548,6 +577,14 @@ gva_input_file_play_back (GvaInputFile *input_file,
         return process;
 }
 
+/**
+ * gva_input_file_get_filename:
+ * @input_file: a #GvaInputFile
+ *
+ * Returns the filename for @input_file.
+ *
+ * Returns: filename for @input_file
+ **/
 const gchar *
 gva_input_file_get_filename (GvaInputFile *input_file)
 {
@@ -556,6 +593,15 @@ gva_input_file_get_filename (GvaInputFile *input_file)
         return input_file->priv->filename;
 }
 
+/**
+ * gva_input_file_get_format:
+ * @input_file: a #GvaInputFile
+ *
+ * Returns a description of the INP header format.  Possible formats
+ * are "INP simple format", "INP extended format", and "INP version x.y".
+ *
+ * Returns: description of the header format
+ **/
 const gchar *
 gva_input_file_get_format (GvaInputFile *input_file)
 {
@@ -567,6 +613,14 @@ gva_input_file_get_format (GvaInputFile *input_file)
         return input_file->priv->format;
 }
 
+/**
+ * gva_input_file_get_game:
+ * @input_file: a #GvaInputFile
+ *
+ * Returns the corresponding ROM name for @input_file.
+ *
+ * Returns: corresponding ROM name for @input_file
+ **/
 const gchar *
 gva_input_file_get_game (GvaInputFile *input_file)
 {
@@ -575,6 +629,14 @@ gva_input_file_get_game (GvaInputFile *input_file)
         return input_file->priv->game;
 }
 
+/**
+ * gva_input_file_get_origin:
+ * @input_file: a #GvaInputFile
+ *
+ * Returns a description of the MAME program that recorded the INP file.
+ *
+ * Returns: description of the MAME program that recorded the INP file
+ **/
 const gchar *
 gva_input_file_get_origin (GvaInputFile *input_file)
 {
@@ -583,6 +645,14 @@ gva_input_file_get_origin (GvaInputFile *input_file)
         return input_file->priv->origin;
 }
 
+/**
+ * gva_input_file_get_timestamp:
+ * @input_file: a #GvaInputFile
+ *
+ * Returns an approximation of when the game recording began.
+ *
+ * Returns: approximation of when the game recording began
+ **/
 time_t
 gva_input_file_get_timestamp (GvaInputFile *input_file)
 {
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]