Fabio Berger
28f5cd0641
Only add Stucts section if there are any
2018-09-28 10:30:24 +01:00
Fabio Berger
144561c53b
Fix missing devdoc comments in output by fixing improper encoding of methodSignatures
2018-09-28 10:28:57 +01:00
Fabio Berger
092b184f45
Fix linter
2018-09-27 23:30:11 +01:00
Fabio Berger
b2ff7bda02
Explain cast to any
2018-09-27 23:24:05 +01:00
Fabio Berger
e0ff3484cf
Improve switch case
2018-09-27 23:20:21 +01:00
Fabio Berger
95e84aae49
Improve comment
2018-09-27 23:18:32 +01:00
Fabio Berger
338b7d2ec0
Alphabetize
2018-09-27 23:16:55 +01:00
Fabio Berger
957af23a64
Include structs section so that we can render struct params/return values properly with a popover
2018-09-27 23:02:12 +01:00
Fabio Berger
d4077ae970
Fix linter
2018-09-27 23:01:12 +01:00
Fabio Berger
5cc11912a7
Pull in only contracts we want rendered on the doc page
2018-09-27 18:39:27 +01:00
Fabio Berger
c55a419178
Split _genMethodDoc into it and _genFallbackDoc for clarity. Add isFallback boolean
2018-09-27 10:57:42 +01:00
F. Eugene Aumson
3f61d27656
fix: add bin file for sol-doc cli
2018-09-26 11:28:53 -04:00
F. Eugene Aumson
2bdaa58d71
fix: use latest versions of @0xproject packages
2018-09-26 09:22:06 -04:00
F. Eugene Aumson
2e7b218f40
fix: comments
...
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
2018-09-25 16:31:40 -04:00
F. Eugene Aumson
7fbfd9ccd9
fix: print error and exit process; don't re-throw
...
https://github.com/0xProject/0x-monorepo/pull/1004#discussion_r219979003
https://github.com/0xProject/0x-monorepo/pull/1004
2018-09-25 16:31:40 -04:00
F. Eugene Aumson
1db5ff617f
fix: split line for readability
...
https://github.com/0xProject/0x-monorepo/pull/1004#discussion_r219978696
https://github.com/0xProject/0x-monorepo/pull/1004
2018-09-25 16:31:40 -04:00
F. Eugene Aumson
ac5376a1ca
fix: rename JSON_TABWIDTH to JSON_TAB_WIDTH
...
https://github.com/0xProject/0x-monorepo/pull/1004#discussion_r219977842
https://github.com/0xProject/0x-monorepo/pull/1004
2018-09-25 16:31:39 -04:00
F. Eugene Aumson
600ffd93a6
fix: use latest versions of @0xproject packages
...
https://github.com/0xProject/0x-monorepo/pull/1004#discussion_r219977747
https://github.com/0xProject/0x-monorepo/pull/1004
2018-09-25 16:31:26 -04:00
F. Eugene Aumson
574270d061
fix: increase mocha timeout value
...
prior CI runs were failing because of this.
2018-09-24 17:17:28 -04:00
F. Eugene Aumson
9af5e3ba8e
fix: add CHANGELOG.json
2018-09-24 17:17:19 -04:00
F. Eugene Aumson
57fca16d7b
fix: use contract name for constructor method name
...
and for its return value
2018-09-24 13:24:03 -04:00
F. Eugene Aumson
a900255820
fix: document indexed event arguments
2018-09-24 13:05:35 -04:00
F. Eugene Aumson
bd7565ceda
fix: save v1 contract doc/deploy commands
...
For posterity, save commands needed to use sol-doc to generate and
deploy documentation objects for v1 contracts.
2018-09-24 12:36:26 -04:00
F. Eugene Aumson
880cd6e440
fix: document return value's type, not its name
2018-09-24 12:29:02 -04:00
F. Eugene Aumson
9f0dfb1e1a
feat: make sol-doc only document what's requested
...
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.
2018-09-22 10:55:46 -04:00
F. Eugene Aumson
37cb18e1da
fix: rename variable
2018-09-22 10:21:27 -04:00
F. Eugene Aumson
3e5d427d4e
feat: add sol-doc command-line interface
...
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.
2018-09-22 10:14:49 -04:00
F. Eugene Aumson
30622631ff
use Array.join rather than string concatenation
2018-09-17 19:31:47 -04:00
F. Eugene Aumson
4bab402e95
doc constructors as returning a Reference...
...
...not an Intrinsic
2018-09-17 19:31:45 -04:00
F. Eugene Aumson
91de15d50e
remove stale comments
2018-09-17 19:31:42 -04:00
F. Eugene Aumson
4ade674ada
test multiple return values from a solidity method
2018-09-17 19:31:37 -04:00
F. Eugene Aumson
401ef2edef
minorly tweak comments
2018-09-17 19:31:34 -04:00
F. Eugene Aumson
9201273939
add and test support for return comment
2018-09-17 19:31:32 -04:00
F. Eugene Aumson
5b07669bd0
add and test support for fallback functions
2018-09-17 19:31:30 -04:00
F. Eugene Aumson
3c7155afb0
test all the natspec stuff we use in our contracts
2018-09-17 19:31:23 -04:00
F. Eugene Aumson
a75981da14
test w/&w/out devdoc content in contract
2018-09-17 17:49:14 -04:00
F. Eugene Aumson
d5f964b58e
test w/&w/out passing in contractsToCompile
2018-09-17 17:49:03 -04:00
F. Eugene Aumson
800dd5fb4f
ammend generated docs with solc's devdoc output
2018-08-31 16:18:17 -04:00
F. Eugene Aumson
3dc4eb4421
rename 2 variables
2018-08-31 15:28:12 -04:00
F. Eugene Aumson
327b4ba554
satisfy linter
2018-08-31 11:18:43 -04:00
F. Eugene Aumson
50b725c687
introduce named vars to clarify return statements
2018-08-31 09:33:26 -04:00
F. Eugene Aumson
9a4e6da02f
enable sol-doc tests in circleci
2018-08-31 09:15:41 -04:00
F. Eugene Aumson
823b6c4d7d
transform solc's ABI output into doc types
2018-08-31 09:12:27 -04:00
F. Eugene Aumson
0e45497acb
rename variables
2018-08-30 12:28:09 -04:00
F. Eugene Aumson
fe7a62ba9a
add named var to make if condition more readable
2018-08-30 12:02:46 -04:00
F. Eugene Aumson
b88a56e6b7
reduce proximity b/w instantiation and use of var
2018-08-30 12:02:46 -04:00
F. Eugene Aumson
297cbd996d
remove unnecessary class SolidityDocFormat
2018-08-30 12:02:42 -04:00
F. Eugene Aumson
f55234b4a0
comment public interface
2018-08-30 11:30:43 -04:00
F. Eugene Aumson
f76c88c549
remove unused constructor parameter
2018-08-30 11:24:41 -04:00
F. Eugene Aumson
863966787f
dev-depend on @0xproject/tslint-config
2018-08-30 10:43:43 -04:00
