hq20/sol-comments-parser

[DEPRECATED] A fast and friendly solidity comments parser :snail:

sol-comments-parser's Issues

parse comments for interfaces

As it's been done with functions, events, and contracts, interfaces also need to have their parameters cast.

Parse single line comments

The NatSpec page shows a few inline comments instead of multiline. Although there might not be many people doing comments like this, we should support it.

It needs to be done by steps

• Single line for functions
• Multiple single lines for functions
• Multiple single lines for everything

Use lexer instead regexp

It will work fast, more relaible and fast.
Some related projects:
https://github.com/ratel-rust/ratel-core/
https://www.npmjs.com/package/solidity-parser-antlr
https://github.com/ConsenSys/solidity-parser

Error on parsing /** ... **/ notations

Single-line comments without spaces at // e.g //Some comment here breaks app at getting element from array by index but doesn't check thats matches returns array and length of array >= 3

Some details:

sol-comments-parser/src/index.js:140
        outputFunctions.set(matched[2], proceedParse(matched[1]));
                                   ^
TypeError: Cannot read property '2' of null
    at rawComments.forEach (sol-comments-parser/src/index.js:140:36)

Maybe add type-checking? e.g Array.isArray(matched) && matched.length >= 3

Travis builds failed - Coveralls.io posting issue

Needs upgrade deps to fix it