Which .cpp files need Doxygen-style comments? (HW4)

Which .cpp files need Doxygen-style comments? (HW4)

by Christian DiMaria -
Number of replies: 4

I just have a quick clarifying question:

For assignment 4, I am adding Doxygen-style comments to friction.h and model.h, so I wasn't planning to repeat those comments in friction.cpp or model.cpp. But for the source files without headers (analyze.cpp and testmodel.cpp), should we also be adding Doxygen-style comments?

Thanks!

In reply to Christian DiMaria

Re: Which .cpp files need Doxygen-style comments? (HW4)

by Ramses van Zon -

Yes, you should add doxygen-style documentation those .cpp files as well.

In reply to Ramses van Zon

Re: Which .cpp files need Doxygen-style comments? (HW4)

by Mahdi Harb -
So for modules we only add dioxygen-style comments for header files?
In reply to Mahdi Harb

Re: Which .cpp files need Doxygen-style comments? (HW4)

by Ramses van Zon -
Not necessarily. Everything in the headers should have doxygen comments, but anything in the cpp files that is not documented in the header needs doxygen comments as well.