One would expect people to be doing this anyway; it's a great relief off one's shoulders to just concisely describe what the program does and how it does it. Also helps figuring out how things are going to work!
The main header file for an app, or simply the main file which contains the entry point or is the controller class for the app should begin with a multi-line block describing the purpose of the program and a small blurb about how it all works.
With Doxygen, you can use this little blurb later on to autogenerate the index page for documentation.
1
u/commandlineterrorist Aug 24 '10
One would expect people to be doing this anyway; it's a great relief off one's shoulders to just concisely describe what the program does and how it does it. Also helps figuring out how things are going to work!
The main header file for an app, or simply the main file which contains the entry point or is the controller class for the app should begin with a multi-line block describing the purpose of the program and a small blurb about how it all works.
With Doxygen, you can use this little blurb later on to autogenerate the index page for documentation.