the `/**   */` will put it in scala docs as a comment for the method.