protocol/packages/sol-doc/test/inputs/BaseContract.sol
Lawrence Forman b7b457b076
Generate (complete) solidity docs (#2391)
* `@0x/sol-doc`: New doc generator.

* `@0x/sol-compiler`: Be more tolerant of AST-only compilation targets.

* `@0x/contracts-exchange`: Add more devdoc comments.
`@0x/contracts-exchange-libs`: Add more devdoc comments.

* `@0x/sol-doc`: Update package script.

* `@0x/sol-doc`: Remove unused files and update package scripts to be easier to configure.

* Add more devdocs to contracts.

* `@0x/sol-doc`: Remove doc artifacts.

* `@0x/sol-doc`: Add `.gitignore` and `.npmignore`.

* `@0x/contracts-exchange`: Fix compilation errors.

* Fix more broken contracts.

* `@0x/contracts-erc20-bridge-sampler`: Fix failing tests.

* `@0x/contracts-asset-proxy`: Remove accidentally introduced hackathion file (lol).

* `@0x/sol-doc`: Prevent some inherited contracts from being included in docs unintentionally.

* `@0x/sol-doc`: Rename test file.

* `@0x/contracts-exchange`: Update `orderEpoch` devdoc.

* `@0x/sol-doc`: Tweak event and function docs.

* Update CODEOWNERS.

* `@0x/sol-doc` Tweak function md generation.

* `@0x/sol-doc`: add `transformDocs()` tests.

* `@0x/sol-doc`: add `extract_docs` tests.

* `@0x/sol-doc` Fix linter errors.

* `@0x/contracts-erc20-bridge-sampler`: Fix broken `ERC20BridgeSampler.sol` compile.

* `@0x/sol-doc` Fix mismatched `dev-utils` dep version.

* `@0x/sol-doc`: Add `gen_md` tests.

* `@0x/sol-doc`: Remove `fs.promises` calls.

* `@0x/sol-doc`: Fix linter errors.

* `@0x/sol-doc`: Export all relevant types and functions.

Co-authored-by: Lawrence Forman <me@merklejerk.com>
2020-01-03 22:59:18 -05:00

44 lines
1.4 KiB
Solidity

pragma solidity ^0.5;
pragma experimental ABIEncoderV2;
import "./InterfaceContract.sol";
import "./LibraryContract.sol";
/// @dev Documentation for `BaseContract`.
contract BaseContract {
/// @dev Documentation for `BaseContractEvent1`.
/// @param p1 Documentation for `p1`.
/// @param p2 Documentation for `p2`.
event BaseContractEvent1(address indexed p1, InterfaceContract.InterfaceStruct p2);
// Documentation for `BaseContractEvent2`.
event BaseContractEvent2(
uint256 p1,
uint256 indexed p2
);
/// @dev Documentation for `baseContractField1`.
/// @param 1 Documentation for `1`.
/// @param 0 Documentation for `0`.
/// @return 0 Documentation for `0`.
mapping (bytes32 => mapping(address => InterfaceContract.InterfaceStruct)) public baseContractField1;
/// @dev Documentation for `baseContractField2`.
/// @param 0 Documentation for `0`.
bytes32[] public baseContractField2;
/// @dev Documentation for `_baseContractField3`.
uint256 private _baseContractField3;
/// @dev Documentation for `baseContractMethod1`.
/// @param p1 Documentation for `p1`.
/// @param p2 Documentation for `p2`.
/// @return 0 Documentation for `0`.
function baseContractMethod1(bytes memory p1, bytes32 p2)
internal
returns (InterfaceContract.InterfaceStruct memory)
{}
}