add: add some comment to the api functions