added documentation for @params