From 712154bc4fcfb50c05c57a875e3b2affdc5e2b1b Mon Sep 17 00:00:00 2001
From: Piotr Dziwinski <piotrdz@gmail.com>
Date: Mon, 13 Aug 2012 00:14:42 +0200
Subject: Rendering functions, documentation

- rewrote the render functions for CEngine, CCloud and CWater
- added documentation
---
 src/graphics/engine/planet.h | 13 +++++++++++++
 1 file changed, 13 insertions(+)

(limited to 'src/graphics/engine/planet.h')

diff --git a/src/graphics/engine/planet.h b/src/graphics/engine/planet.h
index e859cd7..fd119f6 100644
--- a/src/graphics/engine/planet.h
+++ b/src/graphics/engine/planet.h
@@ -35,6 +35,10 @@ namespace Gfx {
 
 class CEngine;
 
+/**
+ * \struct Planet
+ * \brief Planet texture definition
+ */
 struct Planet
 {
     //! Initial position in degrees
@@ -63,6 +67,15 @@ struct Planet
     }
 };
 
+
+/**
+ * \class CPlanet
+ * \brief Planet manager
+ *
+ * Draws the planets orbiting in the sky.
+ *
+ * Planets are drawn in 2D mode, at coordinates calculated from camera position.
+ */
 class CPlanet
 {
 public:
-- 
cgit v1.2.3-1-g7c22