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

Documentation system #17

Open
acardace opened this issue Oct 25, 2017 · 4 comments
Open

Documentation system #17

acardace opened this issue Oct 25, 2017 · 4 comments

Comments

@acardace
Copy link
Member

Add a documentation system and document the code with it. (please don't say Doxygen)

@wikilele
Copy link

Hi, i'll take this issue cause i'm studying vous source code for an internship with Renzo Davoli.
I searched throught internet to find a documentation system, but everyone suggests Doxygen.
What can i do? Is it just possible to make documentation just in latex for example?
Or i have to extract documentation from source code comments? @ichigo663

@acardace
Copy link
Member Author

Best thing to do would be to integrate the documentation into the source code, same effort but double win.
I can point you to some tools:

I've used Doxygen in the past and the final result is rather ugly (at least on my eyes).

@wikilele
Copy link

Thanks,
i think i'll use moxigen. Give me few days to set all up, make practice, and i'm starting as soon as possible.

@wikilele
Copy link

wikilele commented Dec 7, 2017

I'll give you just a little feedback.
I've started documenting the code on my local repository.
Next week i'll contact Renzo Davoli and, i think, i'll fork this project to my github repository.

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

2 participants