update all current functions to include javadoc style function descriptions