Skip to content
This repository has been archived by the owner on Mar 15, 2022. It is now read-only.

Document readerir.h:GenIr class #122

Closed
richardlford opened this issue Feb 24, 2015 · 5 comments
Closed

Document readerir.h:GenIr class #122

richardlford opened this issue Feb 24, 2015 · 5 comments
Assignees

Comments

@richardlford
Copy link
Contributor

Document readerir.h:GenIr class using Doxygen markup.

@AndyAyersMS AndyAyersMS added this to the Go Open milestone Mar 7, 2015
@russellhadley russellhadley modified the milestones: Sprint 80, Go Open Mar 16, 2015
@russellhadley
Copy link
Contributor

@erozenfeld, is there still work to do here?

@erozenfeld
Copy link
Member

Yes, very few methods of GenIR are properly documented.

@AndyAyersMS
Copy link
Member

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.

@AndyAyersMS AndyAyersMS modified the milestones: Sprint 81, Sprint 80 Mar 26, 2015
@russellhadley russellhadley modified the milestones: Sprint 81, Sprint 82 Apr 20, 2015
@russellhadley russellhadley modified the milestones: Sprint 83, Sprint 82 May 5, 2015
@russellhadley
Copy link
Contributor

@richardlford where are we on this?

@russellhadley russellhadley modified the milestones: Sprint 84, Sprint 83 Jun 3, 2015
@richardlford
Copy link
Contributor Author

@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.

@russellhadley russellhadley modified the milestones: Sprint 85, Sprint 84 Jun 18, 2015
@erozenfeld erozenfeld modified the milestones: Sprint 86, Sprint 85 Jun 29, 2015
@erozenfeld erozenfeld modified the milestones: Sprint 87, Sprint 86 Jul 25, 2015
@russellhadley russellhadley removed this from the Sprint 87 milestone Aug 14, 2015
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants