Pnuts User's Guide -> Convensions of This Guide

Conventions of This Guide

The User's Guide follows the following convension to show the usage of a function in a bounding box.

loadFile( String fileName )

This example shows that a function called 'loadFile' takes one parameter of String type.

When a function is overloaded, the possible signatures are connected with the word ' or '.

write(byte[] array , int offset , int length) or
(char[] array , int offset , int length)

When a function has an optional parameter, a pair of curly brace { } is used to indicate that it can be specified optionally.

open(String fileName {, String mode })
An example of optional Parameters

When a parameter is an Object or an array type, the component type may be omitted.

sort(array [ ] )

When a parameter is a function, the parameter list surrounded by parenthesis follows.

memcache(handler ( key ) )
Pnuts User's Guide -> Convensions of This Guide