Skip to content

Library to parse source code and extract data models from it for use in generating documentation

License

Notifications You must be signed in to change notification settings

kevinvandenbreemen/grucd

Repository files navigation

grucd

A library that generates an abstraction of a codebase that you can then use to create artifacts such as UML etc.

Getting Started

You can extract an abstract model of your source code using the SourceCodeExtractor, like this:

        val extractor = SourceCodeExtractor()
        val fileNames = extractor.getFilenamesToVisit(inputFile = null, inputDir = "src/test/resources/")
        val model = extractor.buildModelWithFiles(fileNames)

Your source code is represented using a Model object. This object contains a list of types along with any relations (inheritance, encapsulation, etc) GRUCD can detect between them.

Contributing

About

Library to parse source code and extract data models from it for use in generating documentation

Resources

License

Stars

Watchers

Forks

Packages

No packages published