up

soldoc/.gitignore

@@ -0,0 +1,58 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Gladiator (Glimmer Editor)
+.gladiator
+.DS_Store
+
+
+
+####
+#  exclude all tmp & tmp2 and o directory (in all levels)
+tmp/
+tmp2/
+o/
+
+########
+#  exclude all dbs e.g. artbase.db etc.
+*.db
+
+######
+#  exclude all zips  (in /dl)
+*.zip
+
+
+

soldoc/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 0.0.1 / 2023-02-04
+
+* Everything is new. First release

soldoc/Manifest.txt

@@ -0,0 +1,5 @@
+CHANGELOG.md
+Manifest.txt
+README.md
+Rakefile
+lib/soldoc.rb

soldoc/NOTES.md

@@ -0,0 +1,33 @@
+# soldoc Notes
+
+
+## More
+
+
+solidity ast
+- <https://github.com/OpenZeppelin/solidity-ast> - TypeScript types and a JSON Schema for the Solidity AST
+- <https://solidity-ast.netlify.app/>
+
+
+soldoc  links
+
+<https://github.com/OpenZeppelin/solidity-docgen> - Documentation generator for Solidity projects
+
+> The output is fully configurable through Handlebars templates, but the default templates should do a good job of displaying all of the information in the source code in Markdown format. The generated Markdown files can be used with a static site generator such as Vuepress, MkDocs, Jekyll (GitHub Pages), etc., in order to publish a documentation website.
+>
+> This is a newer version of the tool that has been rewritten and redesigned. Some more work is pending to ease the transition from the previous version and to help with usage and configuration.
+
+
+<https://github.com/tsuberim/soldoc> - A documentation generator for solidity projects, inspired by TypeDoc.
+<https://www.npmjs.com/package/@soldoc/soldoc>
+
+
+<https://github.com/HQ20/soldoc> - A solidity documentation generator, based in NatSpec format. with standalone HTML, pdf, gitbook and docsify output just plug and play.
+
+
+
+<https://www.npmjs.com/search?q=keywords:natspec>
+<https://www.npmjs.com/search?q=keywords:soldoc>
+<https://github.com/topics/soldoc>
+
+

soldoc/README.md

@@ -0,0 +1,48 @@
+# soldoc
+
+soldoc gem - command-line tool for solidity (contract) source code documentationn for Ethereum & Co.
+
+
+* home  :: [github.com/rubycocos/blockchain](https://github.com/rubycocos/blockchain)
+* bugs  :: [github.com/rubycocos/blockchain/issues](https://github.com/rubycocos/blockchain/issues)
+* gem   :: [rubygems.org/gems/soldoc](https://rubygems.org/gems/soldoc)
+* rdoc  :: [rubydoc.info/gems/soldoc](http://rubydoc.info/gems/soldoc)
+
+
+
+## New to the Solidity (Contract) Programming Language?
+
+See [**Awesome Solidity @ Open Blockchains »**](https://github.com/openblockchains/awesome-solidity)
+
+
+
+
+## Usage
+
+To be done
+
+
+
+
+
+
+## Bonus - Awesome Contracts
+
+See the [**Awesome (Ethereum) Contracts  / Blockchain Services @ Open Blockchains**](https://github.com/openblockchains/awesome-contracts) repo.
+that is a cache of (ethereum) contract ABIs (application binary interfaces)
+and  open source code (if verified / available)
+with auto-generated docs via soldoc & friends.
+
+
+
+## License
+
+The scripts are dedicated to the public domain.
+Use it as you please with no restrictions whatsoever.
+
+
+## Questions? Comments?
+
+
+Post them on the [D.I.Y. Punk (Pixel) Art reddit](https://old.reddit.com/r/DIYPunkArt). Thanks.
+

soldoc/Rakefile

@@ -0,0 +1,38 @@
+require 'hoe'
+
+
+###
+# hack/ quick fix for broken intuit_values - overwrite with dummy
+class Hoe
+  def intuit_values( input ); end
+end
+
+
+Hoe.spec 'soldoc' do
+
+  self.version = '0.0.1'
+
+  self.summary = "soldoc gem - command-line tool for solidity (contract) source code documentationn for Ethereum & Co."
+  self.description = summary
+
+  self.urls    = { home: 'https://github.com/rubycocos/blockchain' }
+
+  self.author  = 'Gerald Bauer'
+  self.email   = '[email protected]'
+
+  # switch extension to .markdown for gihub formatting
+  self.readme_file  = 'README.md'
+  self.history_file = 'CHANGELOG.md'
+
+  self.extra_deps = [
+    ['solidity'],
+  ]
+
+  self.licenses = ['Public Domain']
+
+  self.spec_extras = {
+    required_ruby_version: '>= 2.3'
+  }
+
+end
+

soldoc/lib/soldoc.rb

@@ -0,0 +1,7 @@
+require 'solidity'
+
+
+module Soldoc
+end   # module Soldoc
+
+