1.4. YCP Variables

1.4. YCP Variables
	Chapter 1. YCP Module and Client Documentation

The YCP variable description can contain almost all pieces of information as the YCP function description except @param and @return tags that don't make sense here. You can, for instance, describe the variable's textual description, examples, structures, etc. However, it's usual that only the description is given.

Example 1.26. Simple Example of Variable Description

/**
 * Defines the number of connected users for each IP.
 * There might be more connected users from one IP.
 *
 * @struct $[
 *	"192.168.0.1"  : 5,
 *	"192.168.0.12" : 1,
 *	"192.168.0.35" : 3,
 * ]
 *
 * @see GetNumberOfConnectedUsers()
 */
global map <string, integer>  number_of_connected_users = nil;

Example 1.27. The Most Usual Usage

/**
 * Stores the currently selected domain
 */
global string current_domain = "";

Function description tags:

@deprecated
@descr
@example
@ref
@short
@since
@stable
@struct
@unstable

See the YCP function description for usage and parameters of tags mentioned above.