be consistent with the use of `@param [in|out]`, add this for all functions in this module