mantarimay/Aegisub
1
0
Fork 0
forked from mia/Aegisub
Code Pull requests Activity

Add some docstrings to Auto4 LuaAssFile class.

Browse source 
Originally committed to SVN as r4595.
This commit is contained in:
Niels Martin Hansen 2010-06-24 19:32:23 +00:00
parent eec24ce562
commit a71b83f61c
1 changed files with 9 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
aegisub/src/auto4_lua.h
View file

@ -59,35 +59,32 @@ class wxWindow;
namespace Automation4 { namespace Automation4 {
/// DOCME
/// @class LuaAssFile /// @class LuaAssFile
/// @brief DOCME /// @brief Object wrapping an AssFile object for modification through Lua
///
/// DOCME
class LuaAssFile { class LuaAssFile {
private: private:
/// DOCME /// Pointer to file being modified
AssFile *ass; AssFile *ass;
/// DOCME /// Lua state the object exists in
lua_State *L; lua_State *L;
/// DOCME /// Is the feature this object is created for read-only?
bool can_modify; bool can_modify;
/// DOCME /// Are we allowed to set undo points in the feature?
bool can_set_undo; bool can_set_undo;
void CheckAllowModify(); // throws an error if modification is disallowed void CheckAllowModify(); // throws an error if modification is disallowed
/// DOCME /// Cursor for last access into file
std::list<AssEntry*>::iterator last_entry_ptr; std::list<AssEntry*>::iterator last_entry_ptr;
/// Index for last access into file
/// DOCME
int last_entry_id; int last_entry_id;
void GetAssEntry(int n); // set last_entry_ptr to point to item n /// Move last_entry_ptr to index n
void GetAssEntry(int n);
static int ObjectIndexRead(lua_State *L); static int ObjectIndexRead(lua_State *L);
static int ObjectIndexWrite(lua_State *L); static int ObjectIndexWrite(lua_State *L);