Nice comment, but you are kind of duplicating it. I think that your inline codes below explain it better, because you can see the code also. And more, if for some reason someone changes the function code, it will have to update this description also. So, in general, I tend to be more abstract when commenting the function, telling more what you should expect to receive as a return value other than describing how the function do that.