Fixed documentation to work with Gtk-Doc 1.14 and produce as few warnings as possible

[rodin/chimara.git] / libchimara / chimara-glk.h

diff --git a/libchimara/chimara-glk.h b/libchimara/chimara-glk.h
index 8713efe46ef2887c6ba4f2791bd5413d84d2d954..75c774075772080c9601b7c394b526bd5d5e0b0a 100644 (file)
--- a/libchimara/chimara-glk.h
+++ b/libchimara/chimara-glk.h
@@ -40,32 +40,24 @@ typedef struct _ChimaraGlkClass {
 
 /**
  * ChimaraError:
+ * @CHIMARA_LOAD_MODULE_ERROR: There was an error opening the plugin containing 
+ * the Glk program. The error message from <link 
+ * linkend="g-module-error">g_module_error()</link> is appended to the <link
+ * linkend="GError">GError</link> message.
+ * @CHIMARA_NO_GLK_MAIN: The plugin containing the Glk program did not export a 
+ * glk_main() function.
+ * @CHIMARA_PLUGIN_NOT_FOUND: An appropriate interpreter plugin for the 
+ * autodetected game file type could not be found.
+ * @CHIMARA_PLUGIN_ALREADY_RUNNING: A plugin was opened while there was already
+ * another plugin running in the widget.
  * 
  * Error codes returned by #ChimaraGlk widgets and subclasses.
- * <variablelist>
- * <varlistentry>
- *   <term>CHIMARA_LOAD_MODULE_ERROR</term>
- *   <listitem><para>There was an error opening the plugin containing the Glk
- *   program. The error message from <link 
- *   linkend="g-module-error">g_module_error()</link> is appended to the <link
- *   linkend="GError">GError</link> message.</para></listitem>
- * </varlistentry>
- * <varlistentry>
- *   <term>CHIMARA_NO_GLK_MAIN</term>
- *   <listitem><para>The plugin containing the Glk program did not export a 
- *   glk_main() function.</para></listitem>
- * </varlistentry>
- * <varlistentry>
- *   <term>CHIMARA_PLUGIN_NOT_FOUND</term>
- *   <listitem><para>An appropriate interpreter plugin for the autodetected
- *   game file type could not be found.</para></listitem>
- * </varlistentry>
- * </variablelist>
  */
 typedef enum _ChimaraError {
        CHIMARA_LOAD_MODULE_ERROR,
        CHIMARA_NO_GLK_MAIN,
-       CHIMARA_PLUGIN_NOT_FOUND
+       CHIMARA_PLUGIN_NOT_FOUND,
+       CHIMARA_PLUGIN_ALREADY_RUNNING
 } ChimaraError;
 
 /**
@@ -82,21 +74,17 @@ void chimara_glk_set_interactive(ChimaraGlk *glk, gboolean interactive);
 gboolean chimara_glk_get_interactive(ChimaraGlk *glk);
 void chimara_glk_set_protect(ChimaraGlk *glk, gboolean protect);
 gboolean chimara_glk_get_protect(ChimaraGlk *glk);
-void chimara_glk_set_default_font_description(ChimaraGlk *glk, PangoFontDescription *font);
-void chimara_glk_set_default_font_string(ChimaraGlk *glk, const gchar *font);
-PangoFontDescription *chimara_glk_get_default_font_description(ChimaraGlk *glk);
-void chimara_glk_set_monospace_font_description(ChimaraGlk *glk, PangoFontDescription *font);
-void chimara_glk_set_monospace_font_string(ChimaraGlk *glk, const gchar *font);
-PangoFontDescription *chimara_glk_get_monospace_font_description(ChimaraGlk *glk);
+void chimara_glk_set_css_to_default(ChimaraGlk *glk);
+gboolean chimara_glk_set_css_from_file(ChimaraGlk *glk, const gchar *filename, GError **error);
+void chimara_glk_set_css_from_string(ChimaraGlk *glk, const gchar *css);
 void chimara_glk_set_spacing(ChimaraGlk *glk, guint spacing);
 guint chimara_glk_get_spacing(ChimaraGlk *glk);
 gboolean chimara_glk_run(ChimaraGlk *glk, const gchar *plugin, int argc, char *argv[], GError **error);
 void chimara_glk_stop(ChimaraGlk *glk);
 void chimara_glk_wait(ChimaraGlk *glk);
 gboolean chimara_glk_get_running(ChimaraGlk *glk);
-void chimara_glk_feed_char_input(ChimaraGlk *glk, guint32 keycode);
+void chimara_glk_feed_char_input(ChimaraGlk *glk, guint32 keyval);
 void chimara_glk_feed_line_input(ChimaraGlk *glk, const gchar *text);
-void chimara_glk_reset(ChimaraGlk *self);
 
 G_END_DECLS