X-Git-Url: https://git.stderr.nl/gitweb?a=blobdiff_plain;f=libchimara%2Fchimara-if.h;h=89ea5c8538c8e1846ce3ef9b3558db599e73d88e;hb=b4658298daef53fb2ccc3f4fdb48554b17af5b55;hp=006829206867586dc859eb68d96050b80a3fcf7d;hpb=92895be4421d350eb674093c1789d8703c2d8f94;p=rodin%2Fchimara.git

diff --git a/libchimara/chimara-if.h b/libchimara/chimara-if.h
index 0068292..89ea5c8 100644
--- a/libchimara/chimara-if.h
+++ b/libchimara/chimara-if.h
@@ -13,6 +13,11 @@ G_BEGIN_DECLS
 #define CHIMARA_IS_IF_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), CHIMARA_TYPE_IF))
 #define CHIMARA_IF_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj), CHIMARA_TYPE_IF, ChimaraIFClass))
 
+/**
+ * ChimaraIFFormat:
+ * 
+ * Constants representing all game formats supported by the Chimara system.
+ */
 typedef enum _ChimaraIFFormat {
 	CHIMARA_IF_FORMAT_NONE = -1,
 	CHIMARA_IF_FORMAT_Z5,
@@ -24,6 +29,11 @@ typedef enum _ChimaraIFFormat {
 	CHIMARA_IF_NUM_FORMATS
 } ChimaraIFFormat;
 
+/**
+ * ChimaraIFInterpreter:
+ * 
+ * Constants representing the available interpreter plugins.
+ */
 typedef enum _ChimaraIFInterpreter {
 	CHIMARA_IF_INTERPRETER_NONE = -1,
 	CHIMARA_IF_INTERPRETER_FROTZ,
@@ -33,6 +43,11 @@ typedef enum _ChimaraIFInterpreter {
 	CHIMARA_IF_NUM_INTERPRETERS
 } ChimaraIFInterpreter;
 
+/**
+ * ChimaraIFZmachineVersion:
+ * 
+ * Allowed values for the #ChimaraIF:interpreter-number property.
+ */
 typedef enum _ChimaraIFZmachineVersion {
 	CHIMARA_IF_ZMACHINE_DEFAULT = 0,
 	CHIMARA_IF_ZMACHINE_DECSYSTEM_20,
@@ -49,8 +64,15 @@ typedef enum _ChimaraIFZmachineVersion {
 	CHIMARA_IF_ZMACHINE_MAXVAL = CHIMARA_IF_ZMACHINE_TANDY_COLOR
 } ChimaraIFZmachineVersion;
 
+/**
+ * ChimaraIF:
+ * 
+ * This structure contains no public members.
+ */
 typedef struct _ChimaraIF {
 	ChimaraGlk parent_instance;
+	
+	/*< public >*/
 } ChimaraIF;
 
 typedef struct _ChimaraIFClass {