protocol/packages/sol-doc/test/inputs/TestContract.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

56 lines
1.4 KiB
Solidity

pragma solidity ^0.5;
pragma experimental ABIEncoderV2;
import "./InterfaceContract.sol";
import "./LibraryContract.sol";
import "./BaseContract.sol";
/// @dev Documentation for `TestContract`.
contract TestContract is
BaseContract,
InterfaceContract
{
/// @dev Documentation for `testContractMethod1`.
function testContractMethod1() public {}
// Stuff to ignore.
/// @dev Documentation for `testContractMethod2`.
/// @param p2 Documentation for `p2`.
/// @param p1 Documentation for `p1`.
/// @param p3 Documentation for `p3`.
/// @return r1 Documentation for `r1`.
function testContractMethod2(
address p1,
uint256 p2,
LibraryContract.LibraryContractEnum p3
)
internal
returns (int32 r1)
{
return r1;
}
/// @dev Documentation for `testContractMethod3`.
/// @param p1 Documentation for `p1`.
/// @return r1 Documentation for `r1`.
function testContractMethod3(InterfaceContract.InterfaceStruct calldata p1)
external
returns (bytes32[][] memory r1)
{
return r1;
}
// Documentation for `testContractMethod4`.
function testContractMethod4(
LibraryContract.LibraryStruct[] storage p1,
InterfaceContract.InterfaceStruct[] memory p2,
bytes[] memory p3
)
private
returns (bytes memory r1, bytes memory r2)
{
return (r1, r2);
}
}