Update documentation

2 files changed, 16 insertions, 1 deletions

diff --git a/libspectre/spectre-page.h b/libspectre/spectre-page.h
index 0a4fa09..3b85d10 100644
--- a/libspectre/spectre-page.h
+++ b/libspectre/spectre-page.h
@@ -90,6 +90,19 @@ void               spectre_page_render          (SpectrePage          *page,
 						 unsigned char       **page_data,
 						 int                  *row_length);
 
+/* ! Renders a rectangle of the page to RGB32 format. This function can fail
+     @param page The page to renderer
+     @param rc The rendering context specifying how the page has to be rendered
+     @param x The X coordinate of the top left corner of the rectangle
+     @param y The Y coordinate to the top left corner of the rectangle
+     @param width The width of the rectangle
+     @param height The height of the rectangle
+     @param page_data A pointer that will point to the image data
+                      if the call succeeds
+     @param row_length The length of an image row will be returned here. It can
+                       happen that row_length is different than width * 4
+     @see spectre_page_status
+*/
 void               spectre_page_render_slice    (SpectrePage          *page,
 						 SpectreRenderContext *rc,
 						 int                   x,
diff --git a/libspectre/spectre-render-context.h b/libspectre/spectre-render-context.h
index f574eb8..e9cf822 100644
--- a/libspectre/spectre-render-context.h
+++ b/libspectre/spectre-render-context.h
@@ -80,7 +80,9 @@ void                  spectre_render_context_get_resolution         (SpectreRend
 
 /*! Sets the page size in pixels. Rotation shouldn't be considered,
     the page size will be automatically adjusted when rendering according
-    to the rotation selected. 
+    to the rotation selected. Note that the page size doesn't affect the
+    scale. If no page size is given the page bounding box will be used,
+    or the rectangle given when using spectre_page_render_slice
     @param rc The rendering context to modify
     @param width the width of the page
     @param height the height of the page