search

almondtools / regexparser

A Parser for regular expressions
GNU Lesser General Public License v3.0
4 stars 1 forks source link

Docstrings? #3

Open NoahTheDuke opened 1 year ago

NoahTheDuke commented 1 year ago

Hey there! This library is super cool. I'm trying to use it in a Clojure project and I'm struggling a little with the lack of doc strings or meaningful examples. Do you have any non-test example code of how to use this?

No worries if not, I'll figure it out eventually. Thanks so much.

almondtools commented 1 year ago

Sorry for the missing documentation. It would probably take some time to add it.

Maybe you can find some examples by examining the usages of regexparser, e.g. at

https://github.com/almondtools/rexlex https://github.com/almondtools/patternsearchalgorithms

To Parse you have to call RegexParser.parse(). The resulting RegexNode can be analyzed/interpreted with the Visitor Pattern, e.g. NFABuilder.java in patternsearchalgorithms.

If you are struggling with another part of the code (or the upper explanation is not intuitive) do not mind to ask for help. I can probably give you advice.