https://github.com/nodefactoryio/solidity-comments-core

Small NodeJs module for generating solidity comments according to natspec.
https://github.com/nodefactoryio/solidity-comments-core

comments nodejs solidity solidity-documentation

Last synced: 10 months ago
JSON representation

Small NodeJs module for generating solidity comments according to natspec.

• Host: GitHub
• URL: https://github.com/nodefactoryio/solidity-comments-core
• Owner: NodeFactoryIo
• License: mit
• Created: 2018-07-09T13:02:35.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2022-11-10T20:11:58.000Z (over 3 years ago)
• Last Synced: 2025-08-23T10:27:03.239Z (10 months ago)
• Topics: comments, nodejs, solidity, solidity-documentation
• Language: JavaScript
• Homepage: https://www.nodefactory.io
• Size: 559 KB
• Stars: 8
• Watchers: 2
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Solidity comments generator

![build status](https://travis-ci.org/NodeFactoryIo/solidity-comments-core.svg?branch=master)

[![Coverage Status](https://coveralls.io/repos/github/NodeFactoryIo/solidity-comments-core/badge.svg?branch=master)](https://coveralls.io/github/NodeFactoryIo/solidity-comments-core?branch=master)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

-----------------------

Simple library that parses solidity contracts and inserts default solidity comments based on natspec.

## Development

Pull code, run `yarn install`, write tests :)