soldoc 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/CHANGELOG.md +3 -0
- data/Manifest.txt +5 -0
- data/README.md +48 -0
- data/Rakefile +38 -0
- data/lib/soldoc.rb +7 -0
- metadata +102 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: 52f1dfcdef2ee32aac7e84c44d8b266d42afbff35315f060412677b8ae39cc3f
|
|
4
|
+
data.tar.gz: ff700ecf4c8ed30533e371d3d969b7ec7ef6d1ee5854f501e6a98267e86924b5
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: 6b3ce1ce86bb429d2a0c7645f2731e7a92e7c79e7f19bd90037a026fb6828c744fe4c2a3668eccc63aaebc8e5bd4334a7d892f3b2eb9bd8303f91a554f33ebaf
|
|
7
|
+
data.tar.gz: eb92b6464bb7f589e794970e5a69f4981f0672cff78b86b80bd826c9b798b4fd841ade66c64c7fb8bacbf506281978288a9616be980c5ccc5b55a5d3f98a02ec
|
data/CHANGELOG.md
ADDED
data/Manifest.txt
ADDED
data/README.md
ADDED
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# soldoc
|
|
2
|
+
|
|
3
|
+
soldoc gem - command-line tool for solidity (contract) source code documentationn for Ethereum & Co.
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
* home :: [github.com/rubycocos/blockchain](https://github.com/rubycocos/blockchain)
|
|
7
|
+
* bugs :: [github.com/rubycocos/blockchain/issues](https://github.com/rubycocos/blockchain/issues)
|
|
8
|
+
* gem :: [rubygems.org/gems/soldoc](https://rubygems.org/gems/soldoc)
|
|
9
|
+
* rdoc :: [rubydoc.info/gems/soldoc](http://rubydoc.info/gems/soldoc)
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
## New to the Solidity (Contract) Programming Language?
|
|
14
|
+
|
|
15
|
+
See [**Awesome Solidity @ Open Blockchains »**](https://github.com/openblockchains/awesome-solidity)
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
## Usage
|
|
21
|
+
|
|
22
|
+
To be done
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
## Bonus - Awesome Contracts
|
|
30
|
+
|
|
31
|
+
See the [**Awesome (Ethereum) Contracts / Blockchain Services @ Open Blockchains**](https://github.com/openblockchains/awesome-contracts) repo.
|
|
32
|
+
that is a cache of (ethereum) contract ABIs (application binary interfaces)
|
|
33
|
+
and open source code (if verified / available)
|
|
34
|
+
with auto-generated docs via soldoc & friends.
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
## License
|
|
39
|
+
|
|
40
|
+
The scripts are dedicated to the public domain.
|
|
41
|
+
Use it as you please with no restrictions whatsoever.
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
## Questions? Comments?
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
Post them on the [D.I.Y. Punk (Pixel) Art reddit](https://old.reddit.com/r/DIYPunkArt). Thanks.
|
|
48
|
+
|
data/Rakefile
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
require 'hoe'
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
###
|
|
5
|
+
# hack/ quick fix for broken intuit_values - overwrite with dummy
|
|
6
|
+
class Hoe
|
|
7
|
+
def intuit_values( input ); end
|
|
8
|
+
end
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
Hoe.spec 'soldoc' do
|
|
12
|
+
|
|
13
|
+
self.version = '0.0.1'
|
|
14
|
+
|
|
15
|
+
self.summary = "soldoc gem - command-line tool for solidity (contract) source code documentationn for Ethereum & Co."
|
|
16
|
+
self.description = summary
|
|
17
|
+
|
|
18
|
+
self.urls = { home: 'https://github.com/rubycocos/blockchain' }
|
|
19
|
+
|
|
20
|
+
self.author = 'Gerald Bauer'
|
|
21
|
+
self.email = 'wwwmake@googlegroups.com'
|
|
22
|
+
|
|
23
|
+
# switch extension to .markdown for gihub formatting
|
|
24
|
+
self.readme_file = 'README.md'
|
|
25
|
+
self.history_file = 'CHANGELOG.md'
|
|
26
|
+
|
|
27
|
+
self.extra_deps = [
|
|
28
|
+
['solidity'],
|
|
29
|
+
]
|
|
30
|
+
|
|
31
|
+
self.licenses = ['Public Domain']
|
|
32
|
+
|
|
33
|
+
self.spec_extras = {
|
|
34
|
+
required_ruby_version: '>= 2.3'
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
end
|
|
38
|
+
|
data/lib/soldoc.rb
ADDED
metadata
ADDED
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
|
2
|
+
name: soldoc
|
|
3
|
+
version: !ruby/object:Gem::Version
|
|
4
|
+
version: 0.0.1
|
|
5
|
+
platform: ruby
|
|
6
|
+
authors:
|
|
7
|
+
- Gerald Bauer
|
|
8
|
+
autorequire:
|
|
9
|
+
bindir: bin
|
|
10
|
+
cert_chain: []
|
|
11
|
+
date: 2023-02-04 00:00:00.000000000 Z
|
|
12
|
+
dependencies:
|
|
13
|
+
- !ruby/object:Gem::Dependency
|
|
14
|
+
name: solidity
|
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
|
16
|
+
requirements:
|
|
17
|
+
- - ">="
|
|
18
|
+
- !ruby/object:Gem::Version
|
|
19
|
+
version: '0'
|
|
20
|
+
type: :runtime
|
|
21
|
+
prerelease: false
|
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
23
|
+
requirements:
|
|
24
|
+
- - ">="
|
|
25
|
+
- !ruby/object:Gem::Version
|
|
26
|
+
version: '0'
|
|
27
|
+
- !ruby/object:Gem::Dependency
|
|
28
|
+
name: rdoc
|
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
|
30
|
+
requirements:
|
|
31
|
+
- - ">="
|
|
32
|
+
- !ruby/object:Gem::Version
|
|
33
|
+
version: '4.0'
|
|
34
|
+
- - "<"
|
|
35
|
+
- !ruby/object:Gem::Version
|
|
36
|
+
version: '7'
|
|
37
|
+
type: :development
|
|
38
|
+
prerelease: false
|
|
39
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
40
|
+
requirements:
|
|
41
|
+
- - ">="
|
|
42
|
+
- !ruby/object:Gem::Version
|
|
43
|
+
version: '4.0'
|
|
44
|
+
- - "<"
|
|
45
|
+
- !ruby/object:Gem::Version
|
|
46
|
+
version: '7'
|
|
47
|
+
- !ruby/object:Gem::Dependency
|
|
48
|
+
name: hoe
|
|
49
|
+
requirement: !ruby/object:Gem::Requirement
|
|
50
|
+
requirements:
|
|
51
|
+
- - "~>"
|
|
52
|
+
- !ruby/object:Gem::Version
|
|
53
|
+
version: '3.23'
|
|
54
|
+
type: :development
|
|
55
|
+
prerelease: false
|
|
56
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
57
|
+
requirements:
|
|
58
|
+
- - "~>"
|
|
59
|
+
- !ruby/object:Gem::Version
|
|
60
|
+
version: '3.23'
|
|
61
|
+
description: soldoc gem - command-line tool for solidity (contract) source code documentationn
|
|
62
|
+
for Ethereum & Co.
|
|
63
|
+
email: wwwmake@googlegroups.com
|
|
64
|
+
executables: []
|
|
65
|
+
extensions: []
|
|
66
|
+
extra_rdoc_files:
|
|
67
|
+
- CHANGELOG.md
|
|
68
|
+
- Manifest.txt
|
|
69
|
+
- README.md
|
|
70
|
+
files:
|
|
71
|
+
- CHANGELOG.md
|
|
72
|
+
- Manifest.txt
|
|
73
|
+
- README.md
|
|
74
|
+
- Rakefile
|
|
75
|
+
- lib/soldoc.rb
|
|
76
|
+
homepage: https://github.com/rubycocos/blockchain
|
|
77
|
+
licenses:
|
|
78
|
+
- Public Domain
|
|
79
|
+
metadata: {}
|
|
80
|
+
post_install_message:
|
|
81
|
+
rdoc_options:
|
|
82
|
+
- "--main"
|
|
83
|
+
- README.md
|
|
84
|
+
require_paths:
|
|
85
|
+
- lib
|
|
86
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
|
87
|
+
requirements:
|
|
88
|
+
- - ">="
|
|
89
|
+
- !ruby/object:Gem::Version
|
|
90
|
+
version: '2.3'
|
|
91
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
92
|
+
requirements:
|
|
93
|
+
- - ">="
|
|
94
|
+
- !ruby/object:Gem::Version
|
|
95
|
+
version: '0'
|
|
96
|
+
requirements: []
|
|
97
|
+
rubygems_version: 3.3.7
|
|
98
|
+
signing_key:
|
|
99
|
+
specification_version: 4
|
|
100
|
+
summary: soldoc gem - command-line tool for solidity (contract) source code documentationn
|
|
101
|
+
for Ethereum & Co.
|
|
102
|
+
test_files: []
|