adding required params usage in comments for documenation'