doxygen: corrections/updates

Also add depsgraph & physics
This commit is contained in:
Campbell Barton
2015-05-20 12:54:45 +10:00
parent 922d5ed939
commit 5d30c23c35
71 changed files with 307 additions and 139 deletions

View File

@@ -156,10 +156,6 @@ public:
const GHOST_TEmbedderWindowID parentWindow = 0
);
/**
* \section Interface Inherited from GHOST_ISystem
*/
/**
* Retrieves events from the system and stores them in the queue.
* \param waitForEvent Flag to wait for an event (or return immediately).
@@ -170,9 +166,6 @@ public:
bool waitForEvent
);
/**
* \section Interface Inherited from GHOST_System
*/
GHOST_TSuccess
getCursorPosition(
GHOST_TInt32& x,
@@ -206,7 +199,6 @@ public:
) const;
/**
* \section Interface Dirty
* Flag a window as dirty. This will
* generate a GHOST window update event on a call to processEvents()
*/

View File

@@ -35,10 +35,10 @@
* Copyright (C) 2001 NaN Technologies B.V.
*
* @author Laurence, Brecht
* @mainpage IK - Blender inverse kinematics module.
* \author Laurence, Brecht
* \page IK - Blender inverse kinematics module.
*
* @section about About the IK module
* \section about About the IK module
*
* This module allows you to create segments and form them into
* tree. You can then define a goal points that the end of a given
@@ -47,7 +47,7 @@
* to get the as near as possible to the goal. This solver uses an
* inverse jacobian method to find a solution.
*
* @section issues Known issues with this IK solver.
* \section issues Known issues with this IK solver.
*
* - There is currently no support for joint constraints in the
* solver. This is within the realms of possibility - please ask
@@ -60,7 +60,7 @@
* Other algorithms exist which are more suitable for real-time
* applications, please ask if this functionality is required.
*
* @section dependencies Dependencies
* \section dependencies Dependencies
*
* This module only depends on Moto.
*/

View File

@@ -29,20 +29,22 @@
#define __MEM_CACHELIMITER_H__
/**
* @section MEM_CacheLimiter
* \section MEM_CacheLimiter
* This class defines a generic memory cache management system
* to limit memory usage to a fixed global maximum.
*
* Please use the C-API in MEM_CacheLimiterC-Api.h for code written in C.
* \note Please use the C-API in MEM_CacheLimiterC-Api.h for code written in C.
*
* Usage example:
*
* \code{.cpp}
* class BigFatImage {
* public:
* ~BigFatImage() { tell_everyone_we_are_gone(this); }
* };
*
* void doit() {
* void doit()
* {
* MEM_Cache<BigFatImage> BigFatImages;
*
* MEM_Cache_Handle<BigFatImage>* h = BigFatImages.insert(new BigFatImage);
@@ -50,11 +52,12 @@
* BigFatImages.enforce_limits();
* h->ref();
*
* work with image...
* // work with image...
*
* h->unref();
*
* leave image in cache.
* // leave image in cache.
* \endcode
*/
#include <list>

View File

@@ -30,9 +30,9 @@
*/
/**
* @file MEM_RefCountPtr.h
* \file MEM_RefCountPtr.h
* Declaration of MEM_RefCounted and MEM_RefCountable classes.
* @author Laurence
* \author Laurence
*/
#ifndef __MEM_REFCOUNTPTR_H__
@@ -41,7 +41,7 @@
#include <stdlib.h> // for NULL !
/**
* @section MEM_RefCountable
* \section MEM_RefCountable
* This is a base class for reference countable objects.
* If you want an object to be shared using a reference
* counted system derrivce from this class. All subclasses
@@ -50,9 +50,9 @@
* defining a static New() method that returns a ref counted
* ptr to a new()ly allocated instance.
*
* @section Example subclass
*
* \section Example subclass
*
* \code{.cpp}
* class MySharedObject : public MEM_RefCountable {
*
* private :
@@ -68,6 +68,7 @@
*
* // other member functions
* };
* \endcode
*
* Alternitively you may first wish to define a fully functional
* class and then define a reference counting wrapper for this class.
@@ -75,6 +76,8 @@
* counting.
*
* E.g.
*
* \code{.cpp}
* class UsefullClass {
* private :
* ...
@@ -108,7 +111,7 @@
* // mechanism to handle object lifetime.
* ~RcUsefullClass();
* };
*
* \endcode
*
*/
@@ -168,7 +171,7 @@ public :
};
/**
* @section MEM_RefCountPtr
* \section MEM_RefCountPtr
*/
template

View File

@@ -43,7 +43,7 @@
/**
* @section MEM_SmartPtr
* \section MEM_SmartPtr
* This class defines a smart pointer similar to that defined in
* the Standard Template Library but without the painful get()
* semantics to access the internal c style pointer.
@@ -58,8 +58,9 @@
* should not be shared. This is not reliably enforceable in C++
* but this class attempts to make the 1-1 relationship clear.
*
* @section Example usage
* \section Example usage
*
* \code{.cpp}
* class foo {
* ...constructors accessors etc.
* int x[1000];
@@ -86,18 +87,21 @@
* private :
* MEM_SmartPtr<foo> m_foo;
* }
* \endcode
*
* You may also safely construct vectors of MEM_SmartPtrs and
* have the vector own stuff you put into it.
*
* e.g.
* \code{.cpp}
* {
* std::vector<MEM_SmartPtr<foo> > foo_vector;
* foo_vector.push_back( new foo());
* foo_vector.push_back( new foo());
* std::vector<MEM_SmartPtr<foo> > foo_vector;
* foo_vector.push_back( new foo());
* foo_vector.push_back( new foo());
*
* foo_vector[0]->bla();
* foo_vector[0]->bla();
* } // foo_vector out of scope => heap memory freed for both foos
* \endcode
*
* @warning this class should only be used for objects created
* on the heap via the new function. It will not behave correctly