adds comments for params and returns

fixes #9