This repository has been archived by the owner on Mar 15, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 153
Document readerir.h:GenIr class #122
Comments
@erozenfeld, is there still work to do here? |
Yes, very few methods of GenIR are properly documented. |
Note only the newly introduced methods need documentation, since the overrides should be documented in the base class. We also need to reconcile the .cpp vs.h issue. As I'm working through the internals of reader.h I'll pull redundant comments from both readerir.h and readerir.cpp. |
@richardlford where are we on this? |
@russellhadley, as @AndyAyersMS mentioned above, method overrides do not need documentation as they should be documented in the base class. However in looking at the current sources I see a number of non-override methods that do not have documentation. So I would say there is more work to do. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Document readerir.h:GenIr class using Doxygen markup.
The text was updated successfully, but these errors were encountered: