diff options
author | Campbell Barton <ideasman42@gmail.com> | 2012-03-02 20:05:54 +0400 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2012-03-02 20:05:54 +0400 |
commit | 7bbf4b78313df9f6d2c760b527eb36a5d0418b82 (patch) | |
tree | ace55a086362cf5b35174d55442322a793dd32c1 /source/gameengine/SceneGraph | |
parent | c8636ca3dd8bde1cc548ef21fb7a1fd304799164 (diff) |
style cleanup
- spelling - turns out we had tessellation spelt wrong all over.
- use \directive for doxy (not @directive)
- remove BLI_sparsemap.h - was from bmesh merge IIRC but entire file commented and not used.
Diffstat (limited to 'source/gameengine/SceneGraph')
-rw-r--r-- | source/gameengine/SceneGraph/SG_BBox.h | 4 | ||||
-rw-r--r-- | source/gameengine/SceneGraph/SG_Controller.cpp | 4 | ||||
-rw-r--r-- | source/gameengine/SceneGraph/SG_Controller.h | 12 | ||||
-rw-r--r-- | source/gameengine/SceneGraph/SG_Node.h | 4 | ||||
-rw-r--r-- | source/gameengine/SceneGraph/SG_ParentRelation.h | 4 | ||||
-rw-r--r-- | source/gameengine/SceneGraph/SG_Tree.h | 6 |
6 files changed, 15 insertions, 19 deletions
diff --git a/source/gameengine/SceneGraph/SG_BBox.h b/source/gameengine/SceneGraph/SG_BBox.h index 08c242baf5d..5096d65558e 100644 --- a/source/gameengine/SceneGraph/SG_BBox.h +++ b/source/gameengine/SceneGraph/SG_BBox.h @@ -117,14 +117,14 @@ public: /** * Get the eight points that define this bounding box. * - * @param world a world transform to apply to the produced points bounding box. + * \param world a world transform to apply to the produced points bounding box. */ void get(MT_Point3 *box, const MT_Transform &world) const; /** * Get the eight points that define this axis aligned bounding box. * This differs from SG_BBox::get() in that the produced box will be world axis aligned. * The maximum & minimum local points will be transformed *before* splitting to 8 points. - * @param world a world transform to be applied. + * \param world a world transform to be applied. */ void getaa(MT_Point3 *box, const MT_Transform &world) const; diff --git a/source/gameengine/SceneGraph/SG_Controller.cpp b/source/gameengine/SceneGraph/SG_Controller.cpp index 5299c865992..07c89dd7af4 100644 --- a/source/gameengine/SceneGraph/SG_Controller.cpp +++ b/source/gameengine/SceneGraph/SG_Controller.cpp @@ -1,5 +1,4 @@ /* - * @file SG_Controller.cpp * ***** BEGIN GPL LICENSE BLOCK ***** * * This program is free software; you can redistribute it and/or @@ -30,7 +29,6 @@ * \ingroup bgesg */ - #include "SG_Controller.h" void @@ -46,5 +44,3 @@ ClearObject( ){ m_pObject = NULL; } - - diff --git a/source/gameengine/SceneGraph/SG_Controller.h b/source/gameengine/SceneGraph/SG_Controller.h index f6361d2c992..7100debe632 100644 --- a/source/gameengine/SceneGraph/SG_Controller.h +++ b/source/gameengine/SceneGraph/SG_Controller.h @@ -88,12 +88,12 @@ public: /** * Hacky way of passing options to specific controllers - * @param option An integer identifying the option. - * @param value The value of this option. - * @attention This has been placed here to give sca-elements - * @attention some control over the controllers. This is - * @attention necessary because the identity of the controller - * @attention is lost on the way here. + * \param option An integer identifying the option. + * \param value The value of this option. + * \attention This has been placed here to give sca-elements + * \attention some control over the controllers. This is + * \attention necessary because the identity of the controller + * \attention is lost on the way here. */ virtual void diff --git a/source/gameengine/SceneGraph/SG_Node.h b/source/gameengine/SceneGraph/SG_Node.h index 48bbe943892..41133495f2e 100644 --- a/source/gameengine/SceneGraph/SG_Node.h +++ b/source/gameengine/SceneGraph/SG_Node.h @@ -91,7 +91,7 @@ public: * Get the current list of children. Do not use this interface for * adding or removing children please use the methods of this class for * that. - * @return a reference to the list of children of this node. + * \return a reference to the list of children of this node. */ NodeList& GetSGChildren() @@ -101,7 +101,7 @@ public: /** * Get the current list of children. - * @return a const reference to the current list of children of this node. + * \return a const reference to the current list of children of this node. */ const NodeList& GetSGChildren() const diff --git a/source/gameengine/SceneGraph/SG_ParentRelation.h b/source/gameengine/SceneGraph/SG_ParentRelation.h index 07f11c87a36..77172256ef9 100644 --- a/source/gameengine/SceneGraph/SG_ParentRelation.h +++ b/source/gameengine/SceneGraph/SG_ParentRelation.h @@ -28,9 +28,9 @@ /** \file SG_ParentRelation.h * \ingroup bgesg - * @page SG_ParentRelationPage SG_ParentRelation + * \page SG_ParentRelationPage SG_ParentRelation - * @section SG_ParentRelationSection SG_ParentRelation + * \section SG_ParentRelationSection SG_ParentRelation * * This is an abstract interface class to the Scene Graph library. * It allows you to specify how child nodes react to parent nodes. diff --git a/source/gameengine/SceneGraph/SG_Tree.h b/source/gameengine/SceneGraph/SG_Tree.h index b0d74bedec5..dcca1a1442f 100644 --- a/source/gameengine/SceneGraph/SG_Tree.h +++ b/source/gameengine/SceneGraph/SG_Tree.h @@ -81,8 +81,8 @@ public: /** * Gets the eight corners of this treenode's bounding box, * in world coordinates. - * @param box: an array of 8 MT_Point3 - * @example MT_Point3 box[8]; + * \param box: an array of 8 MT_Point3 + * \example MT_Point3 box[8]; * treenode->get(box); */ void get(MT_Point3 *box) const; @@ -127,7 +127,7 @@ public: * It joins pairs of SG_Nodes to minimise the size of the resultant * bounding box. * cf building an optimised Huffman tree. - * @warning O(n^3)!!! + * \warning O(n^3)!!! */ class SG_TreeFactory { |