ycpdoc tool |
example.ycp |
Documentation for ycpdoc. | |
|
|
This module has an unstable interface. |
A few examples can be found here.
Includes
|
Info:
Additional comments to this module. We can also document inputs and outputs of modules. Note that characters < and > are allowed in body.
- Parameters:
-
first First argument description second Second argument description.
- Return value:
-
|map
- Example
-
This example shows multiline example tag. CallModule( io.ycp //
);
Info:
Convert numeric value to hexadecimal string.
- Parameters:
-
i value to convert
- Return value:
-
hexadecimal rep. of i starting by 0x
- Example
-
string hex = tohex(65);
Info:
Who knows what is this function for?!? Note that there can be couple of empty lines between end of comment and define.
- Parameters:
-
i Value to convert. Descriptions of parameters can be multiline. j Some string.
- Return value:
-
? Unknown. Lets show that return value description can be multiline.
Info:
This function has no return value defined.