Ebe needs internal documentation so that people can join the project and figure out how the program works. Doxygen will be used to produce excellent documentation. The plan for this topic is for people to volunteer to produce documentation for one file at a time.
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
I have added doxygen comments to registerwindow.h and regular comments to registerwindow.cpp. Then running doxygen places html documents in dox/html which you can view with a web browser navigating from file:///
This should provide enough help to complete the internal doxygen comments. The results look great. There are more features which could be enabled to get more extensive documentation.
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
I have created a second general page in layout.dox which describes the overall structure of the ebe GUI elements. This might make a good read for learning the names of classes and generally how the GUI is designed. Perhaps someone will add some graphics to either the main or the layout page. At this point minor changes can be made to either and pulled into the main git collection.
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
My next task will be doxyfying datawindow.h and datawindow.cpp. I think I recognize the better pattern now. The .h file should have the class description and very short data descriptions. The doxygen function comments should be in the .cpp file.
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
Ebe needs internal documentation so that people can join the project and figure out how the program works. Doxygen will be used to produce excellent documentation. The plan for this topic is for people to volunteer to produce documentation for one file at a time.
register.cpp and register.h
I will start the doxygen process with these 2 files. I think they will be fairly straighforward and will serve as a guide for the rest.
I have added doxygen comments to registerwindow.h and regular comments to registerwindow.cpp. Then running doxygen places html documents in dox/html which you can view with a web browser navigating from file:///
This should provide enough help to complete the internal doxygen comments. The results look great. There are more features which could be enabled to get more extensive documentation.
I am starting on some introductory documentation in a new file "main.dox" which is the doxygen mainpage (It has the command \mainpage in it).
I have finished my initial version of main.dox.
I have created a second general page in layout.dox which describes the overall structure of the ebe GUI elements. This might make a good read for learning the names of classes and generally how the GUI is designed. Perhaps someone will add some graphics to either the main or the layout page. At this point minor changes can be made to either and pulled into the main git collection.
I will work on backtracewindow.h and backtracewindow.cpp next.
Done.
My next task will be doxyfying datawindow.h and datawindow.cpp. I think I recognize the better pattern now. The .h file should have the class description and very short data descriptions. The doxygen function comments should be in the .cpp file.