If this is supposed to be documentation it should be a proper jsdoc formatted comment.