Skip to content
Permalink
Browse files

Fix doxygen warnings

  • Loading branch information...
TheCycoONE committed Apr 6, 2019
1 parent d7ea376 commit ddaacc580bc86ba3938d5aed8627e791866321aa
Showing with 16 additions and 14 deletions.
  1. +12 −10 CorsixTH/Src/persist_lua.cpp
  2. +1 −1 CorsixTH/Src/th_gfx.h
  3. +1 −1 CorsixTH/Src/th_gfx_font.h
  4. +1 −1 CorsixTH/Src/th_gfx_sdl.h
  5. +1 −1 CorsixTH/Src/th_pathfind.h
@@ -75,10 +75,12 @@ int l_crude_gc(lua_State *L)
can be more efficient to use this structure, which can load them without
concatenating them. Sample usage is:
```
load_multi_buffer ls;
ls.s[0] = lua_tolstring(L, -2, &ls.i[0]);
ls.s[1] = lua_tolstring(L, -1, &ls.i[1]);
lua_load(L, LoadMultiBuffer_t::load_fn, &ls, "chunk name");
```
*/
class load_multi_buffer
{
@@ -116,16 +118,16 @@ class load_multi_buffer
/*!
self - Instance of lua_persist_basic_writer allocated as a Lua userdata
self metatable:
__gc - ~lua_persist_basic_writer (via l_crude_gc)
"<file>:<line>" - <index of function prototype in already written data>
`__gc` - ~lua_persist_basic_writer (via l_crude_gc)
`<file>:<line>` - index of function prototype in already written data
[1] - pre-populated prototype persistance names
"<file>:<line>" - "<name>"
`<file>:<line>` - `<name>`
err - an object which could not be persisted
self environment:
<object> - <index of object in already written data>
`<object>` - index of object in already written data
[1] - permanents table
self environment metatable:
__index - writeObjectRaw (via l_writer_mt_index)
`__index` - writeObjectRaw (via l_writer_mt_index)
upvalue 1 - permanents table
upvalue 2 - self
*/
@@ -709,14 +711,14 @@ int l_writer_mt_index(lua_State *L)
self environment:
[-3] - self
[-2] - pre-populated prototype persistance code
"<name>" - "<code>"
`<name>` - `<code>`
[-1] - pre-populated prototype persistance filenames
"<name>" - "<filename>"
`<name>` - `<filename>`
[ 0] - permanents table
<index> - <object already depersisted>
`<index>` - object already depersisted
self metatable:
__gc - ~lua_persist_basic_reader (via l_crude_gc)
<N> - <userdata to have second __depersist call>
`__gc` - ~lua_persist_basic_reader (via l_crude_gc)
`<N>` - userdata to have second `__depersist` call
*/
class lua_persist_basic_reader : public lua_persist_reader
{
@@ -87,7 +87,7 @@ enum draw_flags : uint32_t
thdf_crop = 1 << 13,
};

/** Helper structure with parameters to create a #THRenderTarget. */
/** Helper structure with parameters to create a #render_target. */
struct render_target_creation_params
{
int width; ///< Expected width of the render target.
@@ -93,7 +93,7 @@ class font
//! Draw a single line of text, splitting it at word boundaries
/*!
This function still only draws a single line of text (i.e. any line
breaks like \r and \n in sMessage are ignored), but inserts line breaks
breaks like `\r` and `\n` in sMessage are ignored), but inserts line breaks
between words so that no single line is wider than iWidth pixels.
If iMaxRows is specified it will simply cut after that many rows.
@param pCanvas The canvas on which to draw. Can be nullptr, in which case
@@ -472,7 +472,7 @@ class sprite_sheet
/*!
@param iSprite Sprite getting the mapped palette.
@param pMap The palette map to apply.
@param iAlt32 What to do for a 32bpp sprite (#THDF_Alt32_Mask bits).
@param iAlt32 What to do for a 32bpp sprite (#thdf_alt32_mask bits).
*/
void set_sprite_alt_palette_map(size_t iSprite, const uint8_t* pMap, uint32_t iAlt32);

@@ -98,7 +98,7 @@ class abstract_pathfinder
//! Expand the \a pNode to its neighbours.
/*!
@param pNode Node to expand.
@param iFlags Flags of the node.
@param flags Flags of the node.
@param iWidth Width of the map.
@return Whether the search is done.
*/

0 comments on commit ddaacc5

Please sign in to comment.
You can’t perform that action at this time.