{"_id":"@augurproject/solidity-docgen","_rev":"4-ffa7861686dbd560a2a0506ace6de506","name":"@augurproject/solidity-docgen","dist-tags":{"latest":"0.2.0-alpha.3"},"versions":{"0.2.0-alpha.2":{"name":"@augurproject/solidity-docgen","version":"0.2.0-alpha.2","description":"Solidity API documentation automatic generator.","bin":{"solidity-docgen":"./dist/cli.js"},"scripts":{"build":"babel --out-dir dist src","test":"jest","test:watch":"jest --watch","prepare":"npm run build"},"dependencies":{"async-file":"^2.0.2","commander":"^2.14.1","glob":"^7.1.3","js-yaml":"^3.12.2","lodash":"^4.17.11","react":"^16.8.3","react-dom":"^16.8.3","solc":"0.5.4"},"devDependencies":{"@babel/cli":"^7.2.3","@babel/core":"^7.2.2","@babel/plugin-proposal-object-rest-spread":"^7.4.0","@babel/preset-env":"^7.3.1","@babel/preset-react":"^7.0.0","@babel/register":"^7.0.0","jest":"^24.1.0","react-test-renderer":"^16.8.1"},"keywords":["solidity","api","documentation","automatic","generator"],"author":{"name":"spalladino@gmail.com"},"contributors":[{"name":"Emilio Almansi","email":"ealmansi@gmail.com","url":"http://ealmansi.github.io/"}],"license":"MIT","gitHead":"6c05dfbc9e8cec79f60c106814ca42e36e5195a5","_id":"@augurproject/solidity-docgen@0.2.0-alpha.2","_npmVersion":"6.4.1","_nodeVersion":"10.15.1","_npmUser":{"name":"petong","email":"jph@jah.net"},"dist":{"integrity":"sha512-I6o3BqYOoteQGkav1/bzj8UW8anjQevUU/Kt6C5WzVnE3ZgcHAvTfgkxnOy6cMsmB9pNzWJdxTqGek2PObOHQg==","shasum":"656e171625e40eed4ff8fc54d04372c674f39473","tarball":"https://registry.npmjs.org/@augurproject/solidity-docgen/-/solidity-docgen-0.2.0-alpha.2.tgz","fileCount":18,"unpackedSize":43260,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJc+AziCRA9TVsSAnZWagAAUw4P/jpM9BMD2a/+OSLX+scy\n+O+DgsxyiRo8kXrrSsXJejGlCQkX5zjnafQWg1XNhKWoAZip7IvJIvyCfCa/\n7l8GQ9HT/ByaFp0wuk3rOX0TEFdf6XRGcRc8OLHfD3bPHpmzUYAcZWXYkzA6\nxhRDCATEWDt+pIc3OB8eA4TQfbi0ATfxftOG0qIGNrvDka56qPOwp0S5fgDW\nU5fXMs3S7kWfZlsBFmee6ySV51YDI6aq8AYME0zsaAF6TQrPn6QUf2ESa2F3\nTh2GSj4jP+GsEtvkaj+56Fv+eyesS9DzmRK5zqlb5m7E81/4zHeI0Jj16L50\nMWAVA/Y2wCgY6WoyGoLfrd4qEOB3w0Ps3/05HExAJI7M+3pr6cYA++/FrJab\nkQsIoeICNa9irGM8uGO0fORmPwILkS6+jqzrDJ3vSXtqkRux3m5vcuLgfhNR\nenAJBKabP8ty3hA/D9FiC7CJZ+hPTMSRpnIKXtBkmduXBD3pLBsiZWa3jkAb\ntHCQdqha55RoyNaaEe9uj9VDOvS4kGW+Mt2TK/qk05Ukr2W+gWdm3thVjcP6\nyIPsBSLLbKDUo6s5/0EViCpfgUKvK/0ILO/nfWlLeXHbqEYr77h9XA7CfYPQ\nkOVaQIQsimMypsw/mgVuozIzTT/GidWzrGBXgMuj4Zybz4CbNnccgpOZhdj3\nbalT\r\n=5Gzu\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCdX4ABYZA8dHdOZyU9qtFpe11tKQrmSujLsHdFZm8ikgIgT/4T1j+O0eq9/Jn6dYcF2FcOcTVSv5R/rZLx2qo8g3Q="}]},"maintainers":[{"name":"adrake333","email":"aaron@augur.net"},{"name":"petong","email":"jph@jah.net"},{"name":"justinbarry","email":"justin@augur.net"},{"name":"pgebheim","email":"pgebheim@gmail.com"},{"name":"tinybike","email":"jack@tinybike.net"},{"name":"nuevoalex","email":"achap5dk@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/solidity-docgen_0.2.0-alpha.2_1559760098021_0.039834107817935616"},"_hasShrinkwrap":false},"0.2.0-alpha.3":{"name":"@augurproject/solidity-docgen","version":"0.2.0-alpha.3","description":"Solidity API documentation automatic generator.","bin":{"solidity-docgen":"./dist/cli.js"},"scripts":{"build":"babel --out-dir dist src","test":"jest","test:watch":"jest --watch","prepare":"npm run build"},"dependencies":{"async-file":"^2.0.2","commander":"^2.14.1","glob":"^7.1.3","js-yaml":"^3.12.2","lodash":"^4.17.11","react":"^16.8.3","react-dom":"^16.8.3","solc":"0.5.4"},"devDependencies":{"@babel/cli":"^7.2.3","@babel/core":"^7.2.2","@babel/plugin-proposal-object-rest-spread":"^7.4.0","@babel/preset-env":"^7.3.1","@babel/preset-react":"^7.0.0","@babel/register":"^7.0.0","jest":"^24.1.0","react-test-renderer":"^16.8.1"},"keywords":["solidity","api","documentation","automatic","generator"],"author":{"name":"spalladino@gmail.com"},"contributors":[{"name":"Emilio Almansi","email":"ealmansi@gmail.com","url":"http://ealmansi.github.io/"}],"license":"MIT","licenseText":"MIT License\n\nCopyright (c) 2018 OpenZeppelin.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","_id":"@augurproject/solidity-docgen@0.2.0-alpha.3","dist":{"shasum":"7ccb905f5e9b213a505fe1ae14ddaf23efc9d390","integrity":"sha512-BOYvq7rxaTM9Alo1yohgMaNFmZQJNP3lzjHX1Zrz970CFy4ywz4+mQuJ/uB3xhlypEhQl1jkSBXtb61mvKkqqA==","tarball":"https://registry.npmjs.org/@augurproject/solidity-docgen/-/solidity-docgen-0.2.0-alpha.3.tgz","fileCount":23,"unpackedSize":43305,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdXHGNCRA9TVsSAnZWagAAWa8P/2ckrCmvyGJcCpZv58Pk\nTlqDNNRyKzEpjVAKuqkEvXP034bV7YmHxqcvHcsLoTeE9bGkNR1QCFcT0+BP\nml/2/hlYO05JzjNXae1GUzGrOyP43nZkHtK2ByuKVCA1QmBBQspMOI80LqSe\n4JkZpeO+fUWYFDWfCitQLm+r2cNb+GVxSguErZnW4QlrjwtJWlbVdtDWHKNA\nhoSWXo3V2NzggLZFPbRH5fYtf559nYMaM6VyDsZk8w8DbMFS1mDsefoMkLa/\nrJBfvQyAaXxR33R2ObiiekapQHcmjMoa7H/4PRxPqBnP69iQeBqMhyq/CcrS\nvxSDNr/DmcFdAiJRx8Nvi3pjXJKHqpyoHPpxCV+kZqxnWE5KN8zZMuqyE4dL\n0MP5Q0+3K2Q1EO7r6TSYPu6rNlbnvMcBamWzhsEGL9zMtDeYpsgq6NHahmXc\nQO+w9OsW4vR0TEDcw6NssWU0xHSEzk8h8omUfG7/dQxLpmDmyi1UuV6Zfwt5\njN4Bq9/uruUqpk3L4hnc/+7viKlB6/087iJRytbEKt+I3pooBEnrOp161c+H\nJkovydvFp6w1xjd+L0L/EYLqAueG4dDvrcyojqt8Ge0580SmAyr0HLcCHQ6U\nyzIFBvtIS4HaWD6OlIYuFCaWRqDqVLBX9E2gPogEDULXAMiwrga+sXI6ioUt\nXB90\r\n=tP4C\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD4e4Nz9WnRbjpKYqRHpy+eMzyLr0/HkgdbGFeLhZFzPAIgers7ZMWJjN2WIk9sOwqTuXpZoMi0hzKsrvEozYTQnyY="}]},"maintainers":[{"name":"adrake333","email":"aaron@augur.net"},{"name":"justinbarry","email":"justin@augur.net"},{"name":"nuevoalex","email":"achap5dk@gmail.com"},{"name":"petong","email":"jph@jah.net"},{"name":"pgebheim","email":"pgebheim@gmail.com"},{"name":"tinybike","email":"jack@tinybike.net"}],"_npmUser":{"name":"nuevoalex","email":"achap5dk@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/solidity-docgen_0.2.0-alpha.3_1566339468581_0.16599560909783317"},"_hasShrinkwrap":false}},"time":{"created":"2019-06-05T18:41:37.960Z","0.2.0-alpha.2":"2019-06-05T18:41:38.197Z","modified":"2022-04-04T16:23:45.918Z","0.2.0-alpha.3":"2019-08-20T22:17:48.746Z"},"maintainers":[{"email":"paul@augur.net","name":"augur-integration"},{"email":"jph@jah.net","name":"petong"},{"email":"justin@augur.net","name":"justinbarry"},{"email":"pgebheim@gmail.com","name":"pgebheim"},{"email":"jack@tinybike.net","name":"tinybike"},{"email":"achap5dk@gmail.com","name":"nuevoalex"}],"description":"Solidity API documentation automatic generator.","keywords":["solidity","api","documentation","automatic","generator"],"contributors":[{"name":"Emilio Almansi","email":"ealmansi@gmail.com","url":"http://ealmansi.github.io/"}],"author":{"name":"spalladino@gmail.com"},"license":"MIT","readme":"# `solidity-docgen`\n\n**Documentation generator for Augur's smart contracts.**\n\n`solidity-docgen` combines inline documentation with long form documents to\ngenerate Augur's smart contract documentation pages.\n\n## Install\n\n```sh\nnpm install solidity-docgen\n```\n\n## Usage\n\n1. Document your source code in inline comments using `@dev` tags in the [NatSpec] format.\n2. Write longer form documentation in a README.md file next to your smart contracts. (Optional)\n3. Run `npm build` in the `augur/augur-core` directory to generate documentation pages in the `augur/docs/docs/contracts` directory.\nIf the contracts have already been compiled, running `npm build:documentation` will have the same effect. \n\n[NatSpec]: https://solidity.readthedocs.io/en/develop/natspec-format.html\n","readmeFilename":"README.md"}