Documentation Generation

Just running the parasol command, or in addition to any of the dev, deploy and test arguments will automatically generate a single README.md markdown file in the docs/ directory containing Natspec Devdoc and ABI documentation for all compiled contracts.

Additionally, while actively running the parasol command, the documentation file will be regenerated on every change.

Usage

Follow the Ethereum Natspec format.

Use triple forward-slash /// for one-line and double asterisk /** .. */ for multi-line:

Token.psol
/// @author Lamarkaz
/**
@dev Checks balance of address
@param _owner The queried address
@return balance of address
*/
function balanceOf(address _owner) constant public returns (uint256 balance) {
return _balances[_owner];
}