Feature/documentation - Githubissues

filiph / egamebook

A procedural sword & sorcery adventure

https://egamebook.com/

BSD 3-Clause "New" or "Revised" License

192 stars 21 forks source link

Feature/documentation #15

Closed Janamou closed 8 years ago

Janamou commented 8 years ago

I updated docgen to a new dartdoc + added a functionality of opening documentation in web browser if --serve is used.

I also created egb.dart (library egb) file with exports of all libraries inside src. And questions:

Maybe we don't want to export them all (I added all libraries inside src)?
Maybe library egb could be excluded by default and only with some parameter (which will not be documented in parser.usage) will be possible to generate documentation also for this libraries?

filiph commented 8 years ago

I like the second option (normal developers shouldn't need to worry about anything outside Scripter — echo, goto, etc.). But this is easy to do afterwards and not needed right now. Let's keep it the way it is.

Thanks!