Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create documentation for all of the projects #6

Open
BradleyChatha opened this issue Nov 19, 2018 · 1 comment
Open

Create documentation for all of the projects #6

BradleyChatha opened this issue Nov 19, 2018 · 1 comment

Comments

@BradleyChatha
Copy link
Member

BradleyChatha commented Nov 19, 2018

In the event that this code will be used by other people other than me, it'd be nice to comment certain things about the project.

  • What all of the tools are and how to use them.

  • What each project is for.

  • [Ties in with the first point] How to develop certain parts of the projects. E.G how to refresh the EF Model, how to create a new editor in DataManager/Maintainer, how to use the tooling to generate certain parts of the projects, etc.

  • Use a documentation generator for all library projects, as this is vital for other people being able to easily sift through library code. For D-based projects, this can be done using ddoc(built in documentation tool), ddox(external tool that produces much nicer documentation than ddoc), or ddox-based tools like scod for even better looking documentation. For everything else, it's probably best to use something like Doxygen, which can parse most major languages and produces decent looking documentation.

@BradleyChatha
Copy link
Member Author

AimDatabaseInterface has been given a Doxyfile, for use with Doxygen

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant