I noted that the API function was not documented in the XML docs. Will try to fix.
—Reply to this email directly or view it on GitHub.