metrics comments
finish adding javadocs to make the checkstyles happy