The hard part about tech writing and documentation is always making it both accessible to the novice and useful to the expert.
We could do something like this for function specs:
Parameters
| Name | Description | Type | ||
|---|---|---|---|---|
| pin | the pin on which to generate the tone | byte | ||
| frequency | the frequency of the tone in hertz | int | ||
| duration | the duration of the tone in milliseconds | int |
Left as an exercise is how to indicate optional parameters.
While this might be tad intimidating to the novices, I think they will tend to just look at the simple examples to get going.
Btw, take a look at one on the Processing reference page.
.andy