From a618215f35d7359a5f4c94a0b88d2449c92c77e7 Mon Sep 17 00:00:00 2001
From: Marc Sunet <jeannekamikaze@gmail.com>
Date: Mon, 3 Sep 2012 19:40:09 +0200
Subject: docs

---
 Spear/Render/AnimatedModel.hs | 12 ++++++------
 Spear/Render/StaticModel.hs   | 10 +++++-----
 2 files changed, 11 insertions(+), 11 deletions(-)

diff --git a/Spear/Render/AnimatedModel.hs b/Spear/Render/AnimatedModel.hs
index 20ec4d1..76e9e7f 100644
--- a/Spear/Render/AnimatedModel.hs
+++ b/Spear/Render/AnimatedModel.hs
@@ -102,7 +102,7 @@ instance Ord AnimatedModelRenderer where
     m1 < m2 = modelResource m1 < modelResource m2
 
 
--- | Create an 'AnimatedModelResource' from the given 'Model'.
+-- | Create an model resource from the given model.
 animatedModelResource :: AnimatedProgramChannels
                       -> Material
                       -> Texture
@@ -150,18 +150,18 @@ animatedModelResource
             material texture boxes rkey
 
 
--- | Release the given 'AnimatedModelResource'.
+-- | Release the given model resource.
 release :: AnimatedModelResource -> Setup ()
 release = Setup.release . rkey
 
 
--- | Create an 'AnimatedModelRenderer' from the given 'AnimatedModelResource'.
+-- | Create a renderer from the given model resource.
 animatedModelRenderer :: AnimationSpeed -> AnimatedModelResource -> AnimatedModelRenderer
 animatedModelRenderer animSpeed modelResource =
     AnimatedModelRenderer modelResource 0 0 0 0 0 animSpeed
 
 
--- | Update the 'AnimatedModelRenderer'.
+-- | Update the renderer.
 update dt (AnimatedModelRenderer model curAnim startFrame endFrame curFrame fp s) =
     AnimatedModelRenderer model curAnim startFrame endFrame curFrame' fp' s
         where f = fp + dt * s
@@ -212,7 +212,7 @@ setAnimationSpeed :: AnimationSpeed -> AnimatedModelRenderer -> AnimatedModelRen
 setAnimationSpeed s r = r { animationSpeed = s }
 
 
--- | Bind the given 'AnimatedModelRenderer' to prepare it for rendering.
+-- | Bind the given renderer to prepare it for rendering.
 bind :: AnimatedProgramUniforms -> AnimatedModelRenderer -> IO ()
 bind (AnimatedProgramUniforms kaLoc kdLoc ksLoc shiLoc texLoc _ _ _ _) modelRend =
     let model' = modelResource modelRend
@@ -223,7 +223,7 @@ bind (AnimatedProgramUniforms kaLoc kdLoc ksLoc shiLoc texLoc _ _ _ _) modelRend
         glUniform1i texLoc 0
 
 
--- | Render the model described by the given 'AnimatedModelRenderer'.
+-- | Render the model described by the given renderer.
 render :: AnimatedProgramUniforms -> AnimatedModelRenderer -> IO ()
 render uniforms (AnimatedModelRenderer model _ _ _ curFrame fp _) =
     let n = nVertices model
diff --git a/Spear/Render/StaticModel.hs b/Spear/Render/StaticModel.hs
index cdd5c31..c67405a 100644
--- a/Spear/Render/StaticModel.hs
+++ b/Spear/Render/StaticModel.hs
@@ -64,7 +64,7 @@ instance Ord StaticModelRenderer where
     m1 < m2 = model m1 < model m2
 
 
--- | Create a 'StaticModelResource' from the given 'Model'.
+-- | Create a model resource from the given model.
 staticModelResource :: StaticProgramChannels
                     -> Material
                     -> Texture
@@ -105,12 +105,12 @@ staticModelResource (StaticProgramChannels vertChan normChan texChan) material t
         vao (unsafeCoerce numVertices) material texture boxes rkey
 
 
--- | Release the given 'StaticModelResource'.
+-- | Release the given model resource.
 release :: StaticModelResource -> Setup ()
 release = Setup.release . rkey
 
 
--- | Create a 'StaticModelRenderer' from the given 'StaticModelResource'.
+-- | Create a renderer from the given model resource.
 staticModelRenderer :: StaticModelResource -> StaticModelRenderer
 staticModelRenderer = StaticModelRenderer
 
@@ -125,7 +125,7 @@ modelRes :: StaticModelRenderer -> StaticModelResource
 modelRes = model
 
 
--- | Bind the given 'StaticModelRenderer' to prepare it for rendering.
+-- | Bind the given renderer to prepare it for rendering.
 bind :: StaticProgramUniforms -> StaticModelRenderer -> IO ()
 bind (StaticProgramUniforms kaLoc kdLoc ksLoc shiLoc texLoc _ _ _) (StaticModelRenderer model) =
     let (Material _ ka kd ks shi) = material model
@@ -136,7 +136,7 @@ bind (StaticProgramUniforms kaLoc kdLoc ksLoc shiLoc texLoc _ _ _) (StaticModelR
         glUniform1i texLoc 0
 
 
--- | Render the given 'StaticModelRenderer'.
+-- | Render the given renderer.
 render :: StaticProgramUniforms -> StaticModelRenderer -> IO ()
 render uniforms (StaticModelRenderer model) =
     let (Material _ ka kd ks shi) = material model
-- 
cgit v1.2.3