I think that we should use Doxygen to generate documentation.
Then, we should update the tutorials and advance them a bit further.
Both the Doxygen documentation and the tutorials should be hosted on the website,
and also they should be a part of the Sqrat package.
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
As soon as error handling gets settled, I will create a doxyfile for Sqrat and begin documenting the source code using Doxygen. Some form of documentation is necessary and Doxygen just makes it a little bit easier to do
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
Doxygen can be used to generate documentation now, but we need to update Sqrat so the documentation generated when Doxygen reads the files is actually good.
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
Okay! The documentation that Doxygen generates is decent now. You just have to open the Doxyfile in the directory with Doxywizard and run Doxygen. It'll put a whole website of HTML in ./docs folder. I'm going to cool off on touching Sqrat for now. However, this issue is not complete until we update the website to have a more conclusive introductory tutorial that involves the new features, and we should upload the Doxygen documentation to the web site too. However, I'm going to take a break and choose not to do those things for awhile while I work on other programming projects. Thanks for keeping the unit tests all good while I mucked with stuff!
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
Thanks. I will look into putting the Doxygen documentation on the Sqrat web site somewhere accessible from the front page in an experimental basis. We can rearrange the directory structure later for easier access.
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
--- old+++ new@@ -1 +1 @@-update the Sqrat documentation for all the new features in (what will become) Sqrat 0.9+update the Sqrat documentation for all the new features in (what will become) Sqrat 0.9 (or 1.0)
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
I think that we should use Doxygen to generate documentation.
Then, we should update the tutorials and advance them a bit further.
Both the Doxygen documentation and the tutorials should be hosted on the website,
and also they should be a part of the Sqrat package.
will look into Doxygen setup
As soon as error handling gets settled, I will create a doxyfile for Sqrat and begin documenting the source code using Doxygen. Some form of documentation is necessary and Doxygen just makes it a little bit easier to do
thanks!
Doxygen can be used to generate documentation now, but we need to update Sqrat so the documentation generated when Doxygen reads the files is actually good.
Okay! The documentation that Doxygen generates is decent now. You just have to open the Doxyfile in the directory with Doxywizard and run Doxygen. It'll put a whole website of HTML in ./docs folder. I'm going to cool off on touching Sqrat for now. However, this issue is not complete until we update the website to have a more conclusive introductory tutorial that involves the new features, and we should upload the Doxygen documentation to the web site too. However, I'm going to take a break and choose not to do those things for awhile while I work on other programming projects. Thanks for keeping the unit tests all good while I mucked with stuff!
Thanks. I will look into putting the Doxygen documentation on the Sqrat web site somewhere accessible from the front page in an experimental basis. We can rearrange the directory structure later for easier access.
Diff:
Any documentation recommendations to clarify confusing concepts are welcome
never mind. I think your documentation is good. I will close this issue->really work done by Wizzard