Return values
You can use annotation tags to describe the value that is returned by an SPL or native function.
- @return <description>
- Describes the value that is returned by an SPL or native function.
The following example shows the SPLDOC markup and code for a simple
function.
/**
This function returns a "hello world" message.
@return the message
*/
rstring getHelloWorldMessage() {
return "hello world";
}
The spl-make-doc command generates documentation: