Documentation

Documentation

Since Version 2.0.0.0 we using an automated code documentation. Here all classes, methods, constants and other code parts are created by the Docs builder as documentation.

Accordingly, above each class or method comes a comment line with all the necessary information.

Here as an example:

--[[
	@method: Show
	@parameter: player:Player | Player for whom the view should be displayed
	
	Displays the view at the player
]]
function WaypointEditor:Show(player)
 -- Code
end

A code part can have the following properties, which are listed in the following groups.

Classes

--[[
	@class: <Name>
	[@extends <Class>]
	[@since <Version>]
	
	<Description>
]]

Methods

--[[
	@method: <Name>
	[@parameter: <Name>:<Type>[ | <Description>]]
	[@return: <Type>[ | <Type>]]
	[@since <Version>]
	
	<Description>
]]

Methods there starts with __<Name> will be declared as private.

Enums

--[[
	@enum: <Name>
	@value: <Value>
	[@since <Version>]
	
	<Description>
]]

Variables

Not all variables need to be documented. This would simply go beyond the scope.

It makes sense to mention variables in the documentation if they can be extended.

--[[
	@variable: <Name>
	[@since <Version>]
	
	<Description>
]]

Variables there starts with __<Name> will be declared as private.

Deprecations

Deprecated parts will be notified by @deprecated. Optional, you can define, since which version the deprecation is presented:

--[[
	@deprecated: <Version>
]]

For a deprecation it is a good solution if you change the <Description> part. Here tell the user why the deprecation is started and what alternatives can be used.