updated glisy .h and .c comments

glisy · Feb 8, 2016 · 5f810e6 · 5f810e6
1 parent f36e79b
commit 5f810e6
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 17 deletions.
diff --git a/include/glisy/glisy.h b/include/glisy/glisy.h
@@ -6,7 +6,7 @@ extern "C" {
 #endif
 
 /**
- * glisy api
+ * Glisy API.
  */
 
 #include <glisy/gl.h>
@@ -18,34 +18,33 @@ extern "C" {
 #include <glisy/renderer.h>
 
 /**
- * cameras.
+ * Cameras.
  */
 
 #include <glisy/camera/perspective.h>
 
 /**
- * Initializes glisy.
- * Returns 1 for success, 0 for failure.
+ * Initialize Glisy.
  */
 
-int
+GLboolean
 glisy_init(void);
 
 /**
- * Terminate glisy.
+ * Terminate Glisy.
  */
 
-void
+GLboolean
 glisy_terminate(void);
 
 /**
- * Renders scene with camera.
+ * Renders a Glisy Scene with a Glisy Camera.
  */
 
 void
-glisy_render(const glisy_renderer,
-             const glisy_scene,
-             const glisy_perspective_camera);
+glisy_render(const glisy_renderer renderer,
+             const glisy_scene scene,
+             const glisy_perspective_camera camera);
 
 #ifdef __cplusplus
 }

diff --git a/src/glisy.c b/src/glisy.c
@@ -1,18 +1,32 @@
 #include <glisy/glisy.h>
 
 /**
- * Initializes glisy.
- * Returns 1 for success, 0 for failure.
+ * Initialize Glisy.
  */
 
-int
-glisy_init() {
+GLboolean
+glisy_init(void) {
+  // @TODO: implement glisy_init()
   return GL_TRUE;
 }
 
 /**
- * Terminate glisy.
+ * Terminate Glisy.
+ */
+
+GLboolean
+glisy_terminate(void) {
+  // @TODO: implement glisy_terminate()
+  return GL_TRUE;
+}
+
+/**
+ * Renders a Glisy Scene with a Glisy Camera.
  */
 
 void
-glisy_terminate(void) {}
+glisy_render(const glisy_renderer renderer,
+             const glisy_scene scene,
+             const glisy_perspective_camera camera) {
+  // @TODO: implement glisy_render()
+}