doc: add missing sentences in a function comment

[hsweif]

I tried to add the missing comments mentioned by #2374 though I'm not the original author. This PR only contains comment changes. Please help check if the change explains the function as desired. Thanks a lot!