Details
-
Type:
Improvement
-
Status: Done
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: afw
-
Labels:
-
Story Points:6
-
Epic Link:
-
Sprint:Alert Production S17 - 4
-
Team:Alert Production
Description
I would like to make some simple modernizations afw code and reduce doxygen warnings as much as practical. The modernizations I had in mind were:
- Move doc strings from .cc files to .h files and standardize their format
- Use namespace lsst { namespace afw { ... in .cc files to make the code easier to read
- Eliminate all <Class>::Ptr and <Class>::ConstPtr typedefs (replacing with std::shared_ptr<Class>) and std::shared_ptr<const Class>).
- Make sure .py files import the appropriate packages from future and (where practical) pass the flake8 linter
- Run clang-format on the code.
Regarding doxygen warnings: I think moving the documentation to .h files will help in many cases. Some warnings may be impractical to fix, such as complaining about not documenting "cls" for python class methods.
Jim Bosch is there any documentation for the RFC, in case I need to defend the change myself?