Fix various issues in code style of method comments:
- Move all heading comments to all non-static methods near their declaration in the FileCheck.h header file.
- Harmonize the action verb in doxygen comments for methods to always be in third person
- Use \returns instead of free text "return" and "returns".
- Document a couple more parameters while at it.