[Add] Slight additions to documentation system.

This commit is contained in:
Allanis 2014-05-19 17:21:04 +01:00
parent 1602244c11
commit ce39edb11d
3 changed files with 14 additions and 5 deletions

View File

@ -204,7 +204,9 @@ TAB_SIZE = 8
# You can put \n's in the value part of an alias to insert newlines.
ALIASES = "luamod=<em>Lua module:</em>"
ALIASES += "luafunc=<em>Lua function:</em>"
ALIASES += "luafunc=@param L Lua State \
@return Number of variables on the Lua State stack.\n\
<p><em>Lua function:</em>"
ALIASES += "luaparam=<em>Lua function parameter:</em>"
# This tag can be used to specify a number of word-keyword mappings (TCL only).

View File

@ -16,7 +16,8 @@ sed -n '
s|^ *\* *@luamod *\(.*\)|module "\1"|p
#rename some tags:
s|^ *\* *@brief|-- @description|p
s|^ *\* *:luaparam|-- @param|p
s|^ *\* *@luaparam|-- @param|p
s|^ *\* *@luareturn|-- @return|p # We accept both @luareturn & @return
#keep tags luadoc understands:
# s|^ *\* *@param|-- @param|p # Use luaparam, param reserved for C arguments.
s|^ *\* *@see|-- @see|p

View File

@ -186,6 +186,8 @@ static int vectorL_createmetatable(lua_State* L) {
*
* @brief The planet metatable is a way to represent a planet in Lua.
*
* @luamod planet
*
* It allows all sorts of operators making it much more natural to use.
*
* To call Members of the metatable always use:
@ -447,6 +449,8 @@ static int planetL_position(lua_State* L) {
*
* @brief Represents a system in Lua.
*
* @luamod system
*
* To call members of the metatable always use:
* @code
* system:function(param)
@ -655,6 +659,8 @@ static int systemL_jumpdistance(lua_State* L) {
*
* @brief Represents a 2d vector in Lua.
*
* @luamod vec2
*
* To call members of the metatable always use:
* @code
* vector:function(param)
@ -868,7 +874,7 @@ static int vectorL_div(lua_State* L) {
* @ingroup META_VECTOR
*
* @brief Get the cartesian positions of the vector.
* @return X and Y position of the vector.
* @luareturn X and Y position of the vector.
*
* @luafunc get()
*/
@ -917,7 +923,7 @@ static int vectorL_set(lua_State* L) {
*
* @brief Get the distance from the Vec2.
* @param vector Vector to get distance from, uses origin(0,0) if not set.
* @return The distance calculated.
* @luareturn The distance calculated.
*
* @luafunc dist(vector)
*/
@ -952,7 +958,7 @@ static int vectorL_distance(lua_State* L) {
* @ingroup META_VECTOR.
*
* @brief Gets the modulus of the vector.
* @return The modulus of the vector.
* @luareturn The modulus of the vector.
* @luafunc mod()
*/
static int vectorL_mod(lua_State* L) {