From 0a958ceb8e7c072926ab052eae97cd78df0634e4 Mon Sep 17 00:00:00 2001
From: dismine <dismine@gmail.com>
Date: Tue, 21 Jan 2014 16:04:17 +0200
Subject: [PATCH] Documentation for  VGObject class.

--HG--
branch : develop
---
 src/geometry/vgobject.h | 59 ++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 58 insertions(+), 1 deletion(-)

diff --git a/src/geometry/vgobject.h b/src/geometry/vgobject.h
index dab8c3fc0..917cef7a9 100644
--- a/src/geometry/vgobject.h
+++ b/src/geometry/vgobject.h
@@ -38,29 +38,86 @@
 namespace GObject
 {
     /**
-     * @brief The NodeDetail enum
+     * @brief The NodeDetail enum type of graphical objects.
      */
     enum Type { Point, Arc, Spline, SplinePath };
     Q_DECLARE_FLAGS(Types, Type)
 }
 Q_DECLARE_OPERATORS_FOR_FLAGS(GObject::Types)
 
+/**
+ * @brief The VGObject class keep information graphical objects.
+ */
 class VGObject
 {
 public:
+    /**
+     * @brief VGObject default constructor.
+     */
     VGObject();
+    /**
+     * @brief VGObject constructor.
+     * @param type type graphical object.
+     * @param idObject id parent object.
+     * @param mode mode creation. Used in modeling mode.
+     */
     VGObject(const GObject::Type &type, const qint64 &idObject = 0, const Draw::Draws &mode = Draw::Calculation);
+    /**
+     * @brief VGObject copy constructor.
+     * @param obj object.
+     */
     VGObject(const VGObject &obj);
+    /**
+     * @brief operator = assignment operator.
+     * @param obj object
+     * @return object
+     */
     VGObject& operator= (const VGObject &obj);
     virtual ~VGObject(){}
+    /**
+     * @brief getIdObject return parent id.
+     * @return parent id or 0 if object don't have parent.
+     */
     qint64          getIdObject() const;
+    /**
+     * @brief setIdObject set parent id.
+     * @param value parent id.
+     */
     void            setIdObject(const qint64 &value);
+    /**
+     * @brief name return name graphical object.
+     * @return name
+     */
     virtual QString name() const;
+    /**
+     * @brief setName set name graphical object.
+     * @param name name graphical object.
+     */
     void            setName(const QString &name);
+    /**
+     * @brief getMode return mode creation.
+     * @return mode.
+     */
     Draw::Draws     getMode() const;
+    /**
+     * @brief setMode set mode creation.
+     * @param value mode.
+     */
     void            setMode(const Draw::Draws &value);
+    /**
+     * @brief getType return object type.
+     * @return type.
+     */
     GObject::Type   getType() const;
+    /**
+     * @brief id return id object.
+     * @return id
+     */
     qint64          id() const;
+    /**
+     * @brief setId set id object.
+     * @param id id.
+     */
     virtual void    setId(const qint64 &id);
 protected:
     /**