Skip to content

Commit d91fb0b

Browse files
rhys-vdwlhog
authored andcommitted
Use /*** on all lua doc comments
1 parent 4fba704 commit d91fb0b

File tree

9 files changed

+15
-15
lines changed

9 files changed

+15
-15
lines changed

rts/Lua/LuaFBOs.cpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -408,7 +408,7 @@ bool LuaFBOs::ApplyDrawBuffers(lua_State* L, int index)
408408
/******************************************************************************/
409409
/******************************************************************************/
410410

411-
/**
411+
/***
412412
* @table gl
413413
*/
414414

@@ -638,7 +638,7 @@ int LuaFBOs::ActiveFBO(lua_State* L)
638638
}
639639

640640

641-
/**
641+
/***
642642
* Bind default or specified via rawFboId numeric id of FBO
643643
*
644644
* @function gl.RawBindFBO
@@ -647,7 +647,7 @@ int LuaFBOs::ActiveFBO(lua_State* L)
647647
* @param rawFboId integer? (Default: 0)
648648
* @return nil
649649
*/
650-
/**
650+
/***
651651
* @function gl.RawBindFBO
652652
* @param fbo Fbo
653653
* @param target GL? (Default: `fbo.target`)

rts/Lua/LuaOpenGL.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1287,7 +1287,7 @@ int LuaOpenGL::EndText(lua_State* L)
12871287
return 0;
12881288
}
12891289

1290-
/**
1290+
/***
12911291
* @table gl
12921292
*/
12931293

rts/Lua/LuaRBOs.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ int LuaRBOs::meta_newindex(lua_State* L)
147147
* @field samples integer will return globalRendering->msaaLevel for multisampled RBO or 0 otherwise
148148
*/
149149

150-
/**
150+
/***
151151
* @class CreateRBOData
152152
* @field target GL
153153
* @field format GL

rts/Lua/LuaShaders.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -549,7 +549,7 @@ GLint LuaShaders::GetUniformLocation(LuaShaders::Program* p, const char* name)
549549
return iter->second.location;
550550
}
551551

552-
/**
552+
/***
553553
* A table of uniform name to value.
554554
*
555555
* The Uniforms are the values you send along with the shader-program. To use

rts/Lua/LuaSyncedRead.cpp

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -962,7 +962,7 @@ int LuaSyncedRead::GetWind(lua_State* L)
962962
* The advantage of it is that it can be read from anywhere (even from LuaUI and AIs!)
963963
******************************************************************************/
964964

965-
/**
965+
/***
966966
* @class RulesParams : table<string, integer>
967967
*/
968968

@@ -4258,7 +4258,7 @@ int LuaSyncedRead::GetUnitCosts(lua_State* L)
42584258
return 3;
42594259
}
42604260

4261-
/**
4261+
/***
42624262
* @class ResourceCost
42634263
* @field metal number
42644264
* @field energy number
@@ -6160,7 +6160,7 @@ int LuaSyncedRead::GetUnitCurrentCommand(lua_State* L)
61606160
* @param count integer Number of commands to return, `-1` returns all commands, `0` returns command count.
61616161
* @return Command[] commands
61626162
*/
6163-
/**
6163+
/***
61646164
* Get the count of commands for a unit.
61656165
*
61666166
* @function Spring.GetUnitCommands
@@ -6387,7 +6387,7 @@ int LuaSyncedRead::GetFactoryCounts(lua_State* L)
63876387
* @param count integer Number of commands to return, `-1` returns all commands, `0` returns command count.
63886388
* @return Command[] commands
63896389
*/
6390-
/**
6390+
/***
63916391
* Get the count of commands for a unit.
63926392
*
63936393
* @function Spring.GetCommandQueue

rts/Lua/LuaTracyExtra.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ static const std::string& GetImmanentPlotName(const char *plotName)
2929
return *tracyLuaPlots.emplace(plotName).first;
3030
}
3131

32-
/**
32+
/***
3333
* Tracy extensions
3434
* @table tracy
3535
*/

rts/Lua/LuaUnsyncedRead.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2790,7 +2790,7 @@ int LuaUnsyncedRead::GetCameraFOV(lua_State* L)
27902790
return 2;
27912791
}
27922792

2793-
/**
2793+
/***
27942794
* @class CameraVectors
27952795
* @field forward xyz
27962796
* @field up xyz

rts/Lua/LuaUtils.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1156,7 +1156,7 @@ void LuaUtils::ParseCommandArray(
11561156
}
11571157
}
11581158

1159-
/**
1159+
/***
11601160
* @alias Facing
11611161
* | 0 # South
11621162
* | 1 # East

rts/Lua/LuaVBOImpl.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -456,7 +456,7 @@ bool LuaVBOImpl::DefineElementArray(const sol::optional<sol::object> attribDefAr
456456
return true;
457457
}
458458

459-
/**
459+
/***
460460
* @alias VBODataType
461461
* | GL.BYTE
462462
* | GL.UNSIGNED_BYTE
@@ -467,7 +467,7 @@ bool LuaVBOImpl::DefineElementArray(const sol::optional<sol::object> attribDefAr
467467
* | GL.FLOAT
468468
*/
469469

470-
/**
470+
/***
471471
* @class VBOAttributeDef
472472
*
473473
* @field id integer

0 commit comments

Comments
 (0)