doc

Signed-off-by: Mattias Andrée <maandree@operamail.com>

1 files changed, 34 insertions, 0 deletions

diff --git a/src/blueshift_randr.pyx b/src/blueshift_randr.pyx
index d5e13b6..8d2909a 100644
--- a/src/blueshift_randr.pyx
+++ b/src/blueshift_randr.pyx
@@ -1,4 +1,20 @@
 # -*- python -*-
+
+# Copyright © 2014  Mattias Andrée (maandree@member.fsf.org)
+# 
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+# 
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
 cimport cython
 from libc.stdlib cimport malloc, free
 
@@ -12,10 +28,25 @@ cdef extern void blueshift_randr_close()
 
 
 def randr_open(int use_screen):
+    '''
+    Start stage of colour curve control
+    
+    @param   use_screen  The screen to use
+    @return              Zero on success
+    '''
     return blueshift_randr_open(use_screen)
 
 
 def randr_apply(unsigned long long use_crtcs, r_curve, g_curve, b_curve):
+    '''
+    Apply stage of colour curve control
+    
+    @param   use_crtcs                         Mask of CRTC:s to use
+    @param   r_curve:list<unsigned short int>  The red colour curve
+    @param   g_curve:list<unsigned short int>  The green colour curve
+    @param   b_curve:list<unsigned short int>  The blue colour curve
+    @return                                    Zero on success
+    '''
     cdef unsigned short int* r
     cdef unsigned short int* g
     cdef unsigned short int* b
@@ -36,5 +67,8 @@ def randr_apply(unsigned long long use_crtcs, r_curve, g_curve, b_curve):
 
 
 def randr_close():
+    '''
+    Resource freeing stage of colour curve control
+    '''
     blueshift_randr_close()