* docs: comment

* fix(definitions): comments extraction

* test: add insta and similar-asserts

* test: add snapshot tests

* docs: typo

* chore: update deps

* test: rename snapshot test

* test: rename test functions

* fix: natspec parser and function returns validation

* wip: trying to refactor the parser

* fix(natspec): single-line comment parser

* refactor(natspec): simplify parser

* refactor(natspec): remove useless space0

* refactor(natspec): rename parsers

* feat: add option to sort results by file path

* chore: add example configs

* fix(variable): raise error on missing natspec

* feat: add config to enforce some items have natspec

* feat(error): allow to enforce natspec

* feat(event): allow to enforce natspec

* feat(function): allow to enforce natspec

* feat(modifier): allow to enforce natspec

* feat(struct): allow to enforce natspec

* feat(constructor): allow to enforce natspec

* feat(enum): allow to enforce natspec

* chore: update readme

* docs: update readme

* docs: add comment

Some functions could benefit from an API change, so this is breaking

* docs: add documentation

* docs: add documentation

* docs: add missing doc

* docs(config): add documentation

* docs: add documentation

* docs: add documentation

* docs: update readme

* docs: update readme

* docs: update readme

* docs: add documentation

* docs: update readme

* refactor!(definitions): conversion functions

* feat(definitions): add is_variant to `Definition`

Co-authored-by: beeb-release-plz[bot] <146623270+beeb-release-plz[bot]@users.noreply.github.com>