Got Gtk-Doc working. Now all the fancy /** comments before the functions

[projects/chimara/chimara.git] / src / stream.h

diff --git a/src/stream.h b/src/stream.h
index 73c46d706de08048a536abc57eef55a608c884be..25c052e072fc968dae7d2c5d39dc55259d5d6aa8 100644 (file)
--- a/src/stream.h
+++ b/src/stream.h
@@ -12,8 +12,15 @@ enum StreamType
        STREAM_TYPE_FILE
 };
 
+/**
+ * glk_stream_struct:
+ *
+ * This is an opaque structure (see <link linkend="chimara-Opaque-Structures">
+ * Opaque Structures</link> and should not be accessed directly.
+ */
 struct glk_stream_struct
 {
+       /*< private >*/
        glui32 rock;
        /* Pointer to the list node in the global stream list that contains this
        stream */
@@ -22,7 +29,7 @@ struct glk_stream_struct
        glui32 file_mode;
        glui32 read_count;
        glui32 write_count;
-       enum StreamType stream_type;
+       enum StreamType type;
        /* Specific to window stream: the window this stream is connected to */
        winid_t window;
        /* For memory and file streams */
@@ -39,5 +46,5 @@ struct glk_stream_struct
 };
 
 strid_t window_stream_new(winid_t window);
-
+void stream_close_common(strid_t str, stream_result_t *result);
 #endif