This is an automated email from the git hooks/post-receive script.
odyx pushed a commit to branch debian/master
in repository colobot.
commit c8498740f25f54d90015e7446258ef202f19f829
Author: krzys-h <krzy...@interia.pl>
Date: Mon Dec 21 21:46:50 2015 +0100
Minor changes to CBotProgram docs
---
src/CBot/CBotProgram.h | 16 ++++++++++------
1 file changed, 10 insertions(+), 6 deletions(-)
diff --git a/src/CBot/CBotProgram.h b/src/CBot/CBotProgram.h
index 4ded0aa..11d4402 100644
--- a/src/CBot/CBotProgram.h
+++ b/src/CBot/CBotProgram.h
@@ -173,13 +173,13 @@ public:
* \parblock
* * timer < 0 do nothing
* * timer >= 0 call SetTimer(int timer) before executing
- * \parblockend
+ * \endparblock
* \return true if the program execution finished, false if the program is
suspended (you then have to call Run() again)
*/
bool Run(void* pUser = nullptr, int timer = -1);
/**
- * \brief GetRunPos Gives the current position in the executing program
+ * \brief Gives the current position in the executing program
* \param[out] functionName Name of the currently executed function
* \param[out] start Starting position in the code string of currently
executed instruction
* \param[out] end Ending position in the code string of currently
executed instruction
@@ -263,6 +263,7 @@ public:
* AddFunction("message", rMessage, cMessage);
* \endcode
*
+ * For more sophisticated examples, see the Colobot source code, mainly
the src/script/scriptfunc.cpp file
*
* \param name Name of the function
* \param rExec Execution function
@@ -283,11 +284,14 @@ public:
/*!
* \brief Save the current execution status into a file
- * \param pf file handle
- * \paramblock
+ * \param pf
+ * \parblock
+ * file handle
+ *
* This file handle must have been opened by this library! Otherwise
crashes on Windows
+ *
* TODO: Verify this
- * \endparamblock
+ * \endparblock
* \return true on success, false on write error
*/
bool SaveState(FILE* pf);
@@ -295,7 +299,7 @@ public:
/*!
* \brief Restore the execution state from a file
*
- * The previous program code must be already recompiled to call this
function
+ * The previous program code must already have been recompiled with
Compile() before calling this function
*
* \param pf file handle
* \return true on success, false on read error
--
Alioth's /usr/local/bin/git-commit-notice on
/srv/git.debian.org/git/pkg-games/colobot.git
_______________________________________________
Pkg-games-commits mailing list
Pkg-games-commits@lists.alioth.debian.org
http://lists.alioth.debian.org/cgi-bin/mailman/listinfo/pkg-games-commits
