Add comments

raycastlib.h

@@ -105,6 +105,10 @@ typedef struct
   Unit height;
 } Camera;
 
+/**
+  Holds an information about a single rendered pixel (for a pixel function
+  that works as a fragment shader.
+*/
 typedef struct
 {
   Vector2D position;  ///< On-screen position.
@@ -123,9 +127,10 @@ typedef struct
 } RayConstraints;
 
 /**
- Function used to retrieve the cells of the rendered scene. It should return
+  Function used to retrieve some information about cells of the rendered scene.
- a "type" of given square as an integer (e.g. square height) - between squares
+  It should return a characteristic of given square as an integer (e.g. square
- that return different numbers there is considered to be a collision.
+  height, texture index, ...) - between squares that return different numbers
+  there is considered to be a collision.
 */ 
 typedef Unit (*ArrayFunction)(int16_t x, int16_t y);
 
@@ -136,7 +141,6 @@ typedef void
 
 /**
   Simple-interface function to cast a single ray.
-
   @return          The first collision result.
  */
 HitResult castRay(Ray ray, ArrayFunction arrayFunc);
@@ -184,7 +188,7 @@ void castRaysMultiHit(Camera cam, ArrayFunction arrayFunc,
   RayConstraints constraints);
 
 /**
- Renders a complete camera view.
+  Using provided functions, renders a complete complex camera view.
 
   @param cam camera whose view to render
   @param floorHeightFunc function that returns floor height (in Units)
@@ -607,7 +611,9 @@ ArrayFunction _floorFunction = 0;
 ArrayFunction _ceilFunction = 0;
 uint8_t _computeTextureCoords = 0;
 
-/// Helper function that determines intersection with both ceiling and floor.
+/**
+  Helper function that determines intersection with both ceiling and floor.
+*/
 Unit _floorCeilFunction(int16_t x, int16_t y)
 {
   // TODO: adjust also for RAYCAST_TINY