search

spaulaus / paass

Pixie Acquisition and Analysis Software Suite - maintained by Project Science
GNU General Public License v3.0
0 stars 2 forks source link

Update the function headers to adhere to the Open/Close Principle #20

Open spaulaus opened 6 years ago

spaulaus commented 6 years ago

Business Value

The function headers should be open for expansion but closed to modification. This means we should only have prototypes in the header, and provide the code in a source file. We'll have an additional library to link in, but this will be safer once installed on a system. Users will have to recompile/install to change these functions rather than simply edit the header. We can take the opportunity to spit the HelperFunctions.hpp into separate libraries. This will prevent the need to include a bunch of extra code if we just need a single namespace.

Functional Requirements

  1. StringManipulationFunctions.hpp gets a corresponding source file, and is compiled into a library.
  2. HelperFunctions.hpp gets split into one library per namespace, which all have corresponding source files.

Developer Notes

spaulaus commented 6 years ago

This issue was moved to spaulaus/paass#67