Improved API documentation (copied from SFML)

This commit is contained in:
Laurent Gomila committed 2011-09-02 20:15:45 +02:00
1 parent c84a787d0a
commit d734c9df5c
50 files changed
+1606 -1478

No files matched your search

+9 -7
View File
@@ -33,26 +33,28 @@
////////////////////////////////////////////////////////////
/// Construct a new context
/// \brief Create a new context
///
/// \return New context
/// This function activates the new context.
///
/// \return New sfContext object
///
////////////////////////////////////////////////////////////
CSFML_API sfContext* sfContext_Create(void);
////////////////////////////////////////////////////////////
/// Destroy an existing context
/// \brief Destroy a context
///
/// \param context : Context to destroy
/// \param context Context to destroy
///
////////////////////////////////////////////////////////////
CSFML_API void sfContext_Destroy(sfContext* context);
////////////////////////////////////////////////////////////
/// Activate or deactivate a context
/// \brief Activate or deactivate explicitely a context
///
/// \param context : Context to activate or deactivate
/// \param active : sfTrue to activate, sfFalse to deactivate
/// \param context Context object
/// \param active sfTrue to activate, sfFalse to deactivate
///
////////////////////////////////////////////////////////////
CSFML_API void sfContext_SetActive(sfContext* context, sfBool active);