solmd

Generate lightweight markdown documentation for Solidity contracts.

Warning: this is not directly compatible with Github Pages as of #c8e8f93fb85fd499e057c79ab40d7d0d873b7ce7. The Github Pages compatible version is at #3215b0298faa40fb5c5d799d78d18e57270bb372

Installation

For the latest version meant to be used with Read the Docs through pandoc:

npm install -g cag/solmd

For a previous version which is Github Pages compatible:

npm install -g cag/solmd#3215b0298faa40fb5c5d799d78d18e57270bb372

Requires solc to installed in your path.

solmd <src> [--dest <target>]

Output will default to sol.md;

Uses Ethereum Natural Specification Format to generate method details.

pragma solidity ^0.4.19;

/// @title A simulator for Bug Bunny, the most famous Rabbit
/// @author Warned Bros
contract BugBunny {

    // tags on storage vars currently unsupported by devdocs
    bytes32 public carrotHash;
    mapping (address => mapping (uint => bool)) public ballerz;

    // tags on events currently unsupported by devdocs
    event Consumption(address indexed feeder, string food);
    event Consumption(address indexed payer, uint amount);
    event AnonEvent() anonymous;

    // tags on constructors currently unsupported by devdocs
    function BugBunny(string carrot) public {
        carrotHash = keccak256(carrot);
    }

    /// @author Birb Lampkett
    /// @notice Determine if Bug will accept `_food` to eat
    /// @dev String comparison may be inefficient
    /// @param _food The name of a food to evaluate (English)
    /// @return true if Bug will eat it, false otherwise
    function doesEat(string _food) public view returns (bool) {
        return keccak256(_food) == carrotHash;
    }

    /// @author Funk Master
    /// @dev Magic funk machine wow.
    /// @param _food The name of a food to eat
    /// @return {
    ///    "eaten": "true if Bug will eat it, false otherwise",
    ///    "hash": "hash of the food to eat"
    /// }
    function eat(string _food) public returns (bool eaten, bytes32 hash) {
        eaten = doesEat(_food);
        hash = keccak256(_food);
        if(eaten) {
            Consumption(msg.sender, _food);
        }
    }

    /// @notice Bug will eat either `food1` or `food2`
    /// @dev Raw stuff.
    /// @param food1 The name of first food to try
    /// @param food2 The name of second food to try
    /// @return {
    ///    "eaten": "true if Bug ate, false otherwise",
    ///    "hash": "hash of the food eaten"
    /// }
    function eat(string food1, string food2) external returns (bool eaten, bytes32 hash) {
        if(doesEat(food1)) {
            (eaten, hash) = eat(food1);
        } else {
            (eaten, hash) = eat(food2);
        }
    }

    // tags on fallback functions currently not supported by devdocs
    function() external payable {
        Consumption(msg.sender, msg.value);
        ballerz[msg.sender][msg.value] = true;
    }
}

/// @title For use the space batle
/// @author Jorge Lucaz
contract StarWar {
    function() external {}
    function pew(uint) public pure returns(uint);
}

Return params may either be a single line or formatted as an object as shown above. In functions with multiple returns, params must be formatted as an object.

The above example will produce the following result as raw markdown.

# BugBunny - StarWar
* [BugBunny](#bugbunny)
  * [Accessors](#bugbunny-accessors)
  * [Events](#bugbunny-events)
    * [Consumption](#consumption-address-indexed-feeder-string-food)(*address* indexed `feeder`, *string* `food`)
    * [Consumption](#consumption-address-indexed-payer-uint256-amount)(*address* indexed `payer`, *uint256* `amount`)
    * [AnonEvent](#anonevent)()
  * [Functions](#bugbunny-functions)
    * [eat](#eat-string-food1-string-food2)(*string* `food1`, *string* `food2`)
    * [eat](#eat-string-_food)(*string* `_food`)
    * [doesEat](#doeseat-string-_food)(*string* `_food`)
* [StarWar](#starwar)
  * [Functions](#starwar-functions)
    * [pew](#pew-uint256)(*uint256*)

# BugBunny

## A simulator for Bug Bunny, the most famous Rabbit

- **Author**: Warned Bros
- **Constructor**: BugBunny(*string* `carrot`)
- This contract has a `payable` fallback function.

## BugBunny Accessors

* *bytes32* carrotHash() `21ba2aed`
* *bool* ballerz(*address*, *uint256*) `ba91571b`

## BugBunny Events

### Consumption(*address* indexed `feeder`, *string* `food`)

**Signature hash**: `be6b16487b5d077520d7501d2566cbd948bb405c595b2095397662a05d7052fe`

### Consumption(*address* indexed `payer`, *uint256* `amount`)

**Signature hash**: `4d03323821b5dfc96a698f2002d64ab816662937a4d5366e851acda40ceb319a`

### AnonEvent()

This event is `anonymous`

## BugBunny Functions

### eat(*string* `food1`, *string* `food2`)

- **State mutability**: `nonpayable`
- **Signature hash**: `26fab75d`
- **Notice**: Bug will eat either `food1` or `food2`

Raw stuff.

#### Inputs

| type     | name    | description                    |
| -------- | ------- | ------------------------------ |
| *string* | `food1` | The name of first food to try  |
| *string* | `food2` | The name of second food to try |

#### Outputs

| type      | name    | description                      |
| --------- | ------- | -------------------------------- |
| *bool*    | `eaten` | true if Bug ate, false otherwise |
| *bytes32* | `hash`  | hash of the food eaten           |

### eat(*string* `_food`)

- **State mutability**: `nonpayable`
- **Signature hash**: `728d9b74`
- **Author**: Funk Master

Magic funk machine wow.

#### Inputs

| type     | name    | description               |
| -------- | ------- | ------------------------- |
| *string* | `_food` | The name of a food to eat |

#### Outputs

| type      | name    | description                              |
| --------- | ------- | ---------------------------------------- |
| *bool*    | `eaten` | true if Bug will eat it, false otherwise |
| *bytes32* | `hash`  | hash of the food to eat                  |

### doesEat(*string* `_food`)

- **State mutability**: `view`
- **Signature hash**: `b6520a32`
- **Author**: Birb Lampkett
- **Notice**: Determine if Bug will accept `_food` to eat

String comparison may be inefficient

#### Inputs

| type     | name    | description                              |
| -------- | ------- | ---------------------------------------- |
| *string* | `_food` | The name of a food to evaluate (English) |

#### Outputs

| type   | description                              |
| ------ | ---------------------------------------- |
| *bool* | true if Bug will eat it, false otherwise |

# StarWar

## For use the space batle

- **Author**: Jorge Lucaz
- **Constructor**: StarWar()
- This contract has a `nonpayable` fallback function.

## StarWar Functions

### pew(*uint256*)

- **State mutability**: `pure`
- **Signature hash**: `1a28180e`

#### Inputs

| type      |
| --------- |
| *uint256* |

#### Outputs

| type      |
| --------- |
| *uint256* |

The same output now parsed:

BugBunny - StarWar

• BugBunny
  • Accessors
  • Events
    • Consumption(address indexed feeder, string food)
    • Consumption(address indexed payer, uint256 amount)
    • AnonEvent()
  • Functions
    • eat(string food1, string food2)
    • eat(string _food)
    • doesEat(string _food)
• StarWar
  • Functions
    • pew(uint256)

BugBunny

A simulator for Bug Bunny, the most famous Rabbit

• Author: Warned Bros
• Constructor: BugBunny(string carrot)
• This contract has a payable fallback function.

BugBunny Accessors

• bytes32 carrotHash() 21ba2aed
• bool ballerz(address, uint256) ba91571b

BugBunny Events

Consumption(address indexed feeder, string food)

Signature hash: be6b16487b5d077520d7501d2566cbd948bb405c595b2095397662a05d7052fe

Consumption(address indexed payer, uint256 amount)

Signature hash: 4d03323821b5dfc96a698f2002d64ab816662937a4d5366e851acda40ceb319a

AnonEvent()

This event is anonymous

BugBunny Functions

eat(string food1, string food2)

• State mutability: nonpayable
• Signature hash: 26fab75d
• Notice: Bug will eat either food1 or food2

Raw stuff.

Inputs

type	name	description
string	food1	The name of first food to try
string	food2	The name of second food to try

Outputs

type	name	description
bool	eaten	true if Bug ate, false otherwise
bytes32	hash	hash of the food eaten

eat(string _food)

• State mutability: nonpayable
• Signature hash: 728d9b74
• Author: Funk Master

Magic funk machine wow.

Inputs

type	name	description
string	_food	The name of a food to eat

Outputs

type	name	description
bool	eaten	true if Bug will eat it, false otherwise
bytes32	hash	hash of the food to eat

doesEat(string _food)

• State mutability: view
• Signature hash: b6520a32
• Author: Birb Lampkett
• Notice: Determine if Bug will accept _food to eat

String comparison may be inefficient

Inputs

type	name	description
string	_food	The name of a food to evaluate (English)

Outputs

type	description
bool	true if Bug will eat it, false otherwise

StarWar

For use the space batle

• Author: Jorge Lucaz
• Constructor: StarWar()
• This contract has a nonpayable fallback function.

StarWar Functions

pew(uint256)

• State mutability: pure
• Signature hash: 1a28180e

Inputs

type
uint256

Outputs

type
uint256

License

MIT