Improve documentation

Former-commit-id: 08d70f6a53a7f12d2748d145d1fe139595a1b39e
This commit is contained in:
Lynix
2016-03-01 15:37:05 +01:00
parent dbce7592a9
commit 1c4135fc09
74 changed files with 277 additions and 242 deletions

View File

@@ -8,12 +8,13 @@
namespace Nz
{
/*!
* \ingroup core
* \class Nz::Thread
* \brief Core class that represents a thread
*/
/*!
* \brief Constructs a Thread<T> object with a function
* \brief Constructs a Thread object with a function
*
* \param function Task the thread will execute in parallel
*/
@@ -25,7 +26,7 @@ namespace Nz
}
/*!
* \brief Constructs a Thread<T> object with a function and its parameters
* \brief Constructs a Thread object with a function and its parameters
*
* \param function Task the thread will execute in parallel
* \param args Arguments of the function
@@ -38,7 +39,7 @@ namespace Nz
}
/*!
* \brief Constructs a Thread<T> object with a member function and its object
* \brief Constructs a Thread object with a member function and its object
*
* \param function Task the thread will execute in parallel
* \param object Object on which the method will be called