Commentaar toegevoegd aan code en tevens Gtk-Doc comments voor alle

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

diff --git a/src/stream.h b/src/stream.h
index fb7eb8f7bc53814a376d897318bfa044315924b1..3fd4fcba07717fee0ec1b74f890d4cb0a31811a2 100644 (file)
--- a/src/stream.h
+++ b/src/stream.h
@@ -11,25 +11,28 @@ enum StreamType
        STREAM_TYPE_MEMORY,
        STREAM_TYPE_FILE,
        STREAM_TYPE_UNICODE_MEMORY,
-       STREAM_TYPE_UNICODE_FILE,
+       STREAM_TYPE_UNICODE_FILE
 };
 
 struct glk_stream_struct
 {
-       GList* stream_list;
-
        glui32 rock;
+       /* Pointer to the list node in the global stream list that contains this
+       stream */
+       GList* stream_list;
+       /* Stream parameters */
        glui32 file_mode;
        glui32 read_count;
        glui32 write_count;
        enum StreamType stream_type;
+       /* Specific to window stream: the window this stream is connected to */
        winid_t window;
+       /* Specific to memory streams */
        gchar *memory_buffer;
        glui32 *memory_buffer_unicode;
        glui32 buffer_len;
 };
 
-
 strid_t window_stream_new(winid_t window);
 
 #endif