From: José Fonseca <jrfonseca@tungstengraphics.com>
Date: Tue, 20 Nov 2007 14:27:52 +0000 (+0000)
Subject: Document return types.
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=79ad82477adab2c234370623c48c35316e94ad02;p=mesa.git

Document return types.
---

diff --git a/src/mesa/pipe/p_winsys.h b/src/mesa/pipe/p_winsys.h
index f46807995d8..2aac403c20b 100644
--- a/src/mesa/pipe/p_winsys.h
+++ b/src/mesa/pipe/p_winsys.h
@@ -138,20 +138,30 @@ struct pipe_winsys
     * usage is a bitmask of PIPE_BUFFER_USAGE_PIXEL/VERTEX/INDEX/CONSTANT. This
     * usage argument is only an optimization hint, not a guarantee, therefore 
     * proper behavior must be observed in all circumstances.
+    * 
+    * Returns zero on success.
     */
    int (*buffer_data)(struct pipe_winsys *sws, 
 		       struct pipe_buffer_handle *buf,
 		       unsigned size, const void *data,
 		       unsigned usage);
 
-   /** Modify some or all of the data contained in a buffer's data store */
+   /** 
+    * Modify some or all of the data contained in a buffer's data store.
+    * 
+    * Returns zero on success.
+    */
    int (*buffer_subdata)(struct pipe_winsys *sws, 
                          struct pipe_buffer_handle *buf,
                          unsigned long offset, 
                          unsigned long size, 
                          const void *data);
 
-   /** Query some or all of the data contained in a buffer's data store */
+   /** 
+    * Query some or all of the data contained in a buffer's data store.
+    * 
+    * Returns zero on success.
+    */
    int (*buffer_get_subdata)(struct pipe_winsys *sws, 
                              struct pipe_buffer_handle *buf,
                              unsigned long offset,