From 79bdc0e8dd51d9e77eb63b15c3e22ab593d92950 Mon Sep 17 00:00:00 2001 From: Changhua Date: Sat, 20 Aug 2022 18:36:42 +0800 Subject: [PATCH] Add func docstring and keyword arguments --- SDKpy/sdkpy.cpp | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/SDKpy/sdkpy.cpp b/SDKpy/sdkpy.cpp index f03c114..967f59a 100644 --- a/SDKpy/sdkpy.cpp +++ b/SDKpy/sdkpy.cpp @@ -6,7 +6,7 @@ namespace py = pybind11; -int WxEnableRecvMsgPy(const std::function &onMsg) { return WxEnableRecvMsg(onMsg); } +int WxEnableRecvMsgPy(const std::function& onMsg) { return WxEnableRecvMsg(onMsg); } PYBIND11_MODULE(wcferry, m) { @@ -31,13 +31,13 @@ PYBIND11_MODULE(wcferry, m) .def_readonly("wxCity", &WxContact::wxCity) .def_readonly("wxGender", &WxContact::wxGender); - m.def("WxInitSDK", &WxInitSDK); - m.def("WxEnableRecvMsg", &WxEnableRecvMsgPy); - m.def("WxDisableRecvMsg", &WxDisableRecvMsg); - m.def("WxSendTextMsg", &WxSendTextMsg); - m.def("WxSendImageMsg", &WxSendImageMsg); - m.def("WxGetContacts", &WxGetContacts, py::return_value_policy::reference); - m.def("WxGetMsgTypes", &WxGetMsgTypes, py::return_value_policy::reference); + m.def("WxInitSDK", &WxInitSDK, "Initiate SDK. Return 0 on success，else on failure."); + m.def("WxEnableRecvMsg", &WxEnableRecvMsgPy, "Enable message receiving and provide a callback", py::arg("onMsg")); + m.def("WxDisableRecvMsg", &WxDisableRecvMsg, "Disable message receiving."); + m.def("WxSendTextMsg", &WxSendTextMsg, "Send text message.", py::arg("wxid"), py::arg("msg"), py::arg("atWxids")=L""); + m.def("WxSendImageMsg", &WxSendImageMsg, "Send image message.", py::arg("wxid"), py::arg("path")); + m.def("WxGetContacts", &WxGetContacts, py::return_value_policy::reference, "Get contact list."); + m.def("WxGetMsgTypes", &WxGetMsgTypes, py::return_value_policy::reference, "Get message types."); #ifdef VERSION_INFO m.attr("__version__") = VERSION_INFO;