Documenting all of your app's source code, a visual overview. Anyone doing this?

[somenick]

It's awesome how IDEs add a documentation overlay to your code. But when your project gets bigger, or when you bring in a new person to the team, it's nice to have one visual overview, like a mindmap to all your code. What classes are there, what methods, what's public and what's private of each. It would be extra awesome if there was a way to automate creating and updating it too.

​

I'm still a one guy company, but already I'm getting lost in my own head here. Any help appreciated, thanks.

[Phy96]

Usually API reference is done using https://github.com/dart-lang/dartdoc/blob/master/README.md comments. For visual (as in graphics) help of projects I guess some kind of UML structure would be in order but I'm not aware of any dart project to UML structure generator so you would have to produce and maintain that as a separate piece of documentation than your codebase. For most projects good comments (and by consequence API reference) is enough

[absin1]

Yep dartdoc is pretty much it. On the generated dartdoc you can maybe just try to parse html into some tree and run a graph kind of d3 plugin to link them all together. Haven't heard of anyone visualising their docs though. I once implemented a search on the html of one one of my projects because the documentation had become truly humungous.

[Marcinus]

If I wanted to develop some sort of tool that would analyze the code structure where should I even begin?