aboutsummaryrefslogtreecommitdiffstats
path: root/packages/sol-doc
Commit message (Collapse)AuthorAgeFilesLines
* Include structs section so that we can render struct params/return values ↵Fabio Berger2018-09-282-26/+212
| | | | properly with a popover
* Fix linterFabio Berger2018-09-281-2/+2
|
* Pull in only contracts we want rendered on the doc pageFabio Berger2018-09-281-1/+1
|
* Split _genMethodDoc into it and _genFallbackDoc for clarity. Add isFallback ↵Fabio Berger2018-09-271-22/+32
| | | | boolean
* fix: add bin file for sol-doc cliF. Eugene Aumson2018-09-261-0/+2
|
* fix: use latest versions of @0xproject packagesF. Eugene Aumson2018-09-261-3/+3
|
* fix: commentsF. Eugene Aumson2018-09-261-3/+3
| | | | | | https://github.com/0xProject/0x-monorepo/pull/1004#discussion_r219990314 https://github.com/0xProject/0x-monorepo/pull/1004#discussion_r220007992 https://github.com/0xProject/0x-monorepo/pull/1004
* fix: print error and exit process; don't re-throwF. Eugene Aumson2018-09-261-1/+4
| | | | | https://github.com/0xProject/0x-monorepo/pull/1004#discussion_r219979003 https://github.com/0xProject/0x-monorepo/pull/1004
* fix: split line for readabilityF. Eugene Aumson2018-09-261-3/+2
| | | | | https://github.com/0xProject/0x-monorepo/pull/1004#discussion_r219978696 https://github.com/0xProject/0x-monorepo/pull/1004
* fix: rename JSON_TABWIDTH to JSON_TAB_WIDTHF. Eugene Aumson2018-09-261-2/+2
| | | | | https://github.com/0xProject/0x-monorepo/pull/1004#discussion_r219977842 https://github.com/0xProject/0x-monorepo/pull/1004
* fix: use latest versions of @0xproject packagesF. Eugene Aumson2018-09-261-4/+4
| | | | | https://github.com/0xProject/0x-monorepo/pull/1004#discussion_r219977747 https://github.com/0xProject/0x-monorepo/pull/1004
* fix: increase mocha timeout valueF. Eugene Aumson2018-09-251-1/+1
| | | | prior CI runs were failing because of this.
* fix: add CHANGELOG.jsonF. Eugene Aumson2018-09-251-0/+12
|
* fix: use contract name for constructor method nameF. Eugene Aumson2018-09-251-6/+10
| | | | and for its return value
* fix: document indexed event argumentsF. Eugene Aumson2018-09-251-2/+3
|
* fix: save v1 contract doc/deploy commandsF. Eugene Aumson2018-09-251-1/+3
| | | | | For posterity, save commands needed to use sol-doc to generate and deploy documentation objects for v1 contracts.
* fix: document return value's type, not its nameF. Eugene Aumson2018-09-252-6/+6
|
* feat: make sol-doc only document what's requestedF. Eugene Aumson2018-09-222-18/+29
| | | | | | | | if a list of contracts-to-document is passed into sol-doc, then the output should only contain documentation for the contracts requested. if an empty/undefined list is passed, then it should document all contracts that were found.
* fix: rename variableF. Eugene Aumson2018-09-221-3/+3
|
* feat: add sol-doc command-line interfaceF. Eugene Aumson2018-09-222-2/+34
| | | | | | | | modified sol-compiler to output progress/warning/error/etc messages to stderr rather than stdout, so that sol-doc can put its output (and nothing else) to stdout. for posterity, added sol-doc cli usage as npm scripts to package.json.
* use Array.join rather than string concatenationF. Eugene Aumson2018-09-181-7/+5
|
* doc constructors as returning a Reference...F. Eugene Aumson2018-09-181-1/+1
| | | | ...not an Intrinsic
* remove stale commentsF. Eugene Aumson2018-09-181-9/+4
|
* test multiple return values from a solidity methodF. Eugene Aumson2018-09-182-0/+27
|
* minorly tweak commentsF. Eugene Aumson2018-09-182-3/+2
|
* add and test support for return commentF. Eugene Aumson2018-09-182-0/+12
|
* add and test support for fallback functionsF. Eugene Aumson2018-09-182-1/+8
|
* test all the natspec stuff we use in our contractsF. Eugene Aumson2018-09-182-1/+140
|
* test w/&w/out devdoc content in contractF. Eugene Aumson2018-09-182-56/+176
|
* test w/&w/out passing in `contractsToCompile`F. Eugene Aumson2018-09-182-59/+76
|
* ammend generated docs with solc's devdoc outputF. Eugene Aumson2018-09-012-15/+63
|
* rename 2 variablesF. Eugene Aumson2018-09-011-4/+4
|
* satisfy linterF. Eugene Aumson2018-08-313-6/+3
|
* introduce named vars to clarify return statementsF. Eugene Aumson2018-08-311-2/+5
|
* enable sol-doc tests in circleciF. Eugene Aumson2018-08-312-0/+3
|
* transform solc's ABI output into doc typesF. Eugene Aumson2018-08-313-66/+284
|
* rename variablesF. Eugene Aumson2018-08-311-7/+7
|
* add named var to make `if` condition more readableF. Eugene Aumson2018-08-311-1/+2
|
* reduce proximity b/w instantiation and use of varF. Eugene Aumson2018-08-311-2/+1
|
* remove unnecessary class SolidityDocFormatF. Eugene Aumson2018-08-313-10/+3
|
* comment public interfaceF. Eugene Aumson2018-08-301-1/+13
|
* remove unused constructor parameterF. Eugene Aumson2018-08-302-6/+2
|
* dev-depend on @0xproject/tslint-configF. Eugene Aumson2018-08-301-0/+1
|
* correct package.json's privacy specificationF. Eugene Aumson2018-08-301-1/+3
|
* move shared doc types from react-docs to @0x/typesF. Eugene Aumson2018-08-302-2/+2
|
* add devdoc support to solc typings, and use itF. Eugene Aumson2018-08-291-4/+10
|
* add package sol-docF. Eugene Aumson2018-08-299-0/+262