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

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

diff --git a/src/stream.h b/src/stream.h
index 04134f5807f307b592adc5779eaca1208743bc00..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 */