please comment function using YUIDoc syntax.