updates logging documentation

## motivation

Now that we are using markdown + yard, the rdoc formatting is not working.

In the context of documentation, most of the methods in the class have been marked with visibility private.