Merge pull request #278 from luxonis/update_doc

Update documentation

Author: csaba-luxonis

depthai-core

@@ -22,7 +22,7 @@ void CalibrationHandlerBindings::bind(pybind11::module& m){
 
         .def("getDefaultIntrinsics", &CalibrationHandler::getDefaultIntrinsics, py::arg("cameraId"), DOC(dai, CalibrationHandler, getDefaultIntrinsics))
         .def("getDistortionCoefficients", &CalibrationHandler::getDistortionCoefficients, py::arg("cameraId"), DOC(dai, CalibrationHandler, getDistortionCoefficients))
-        
+
         .def("getFov", &CalibrationHandler::getFov, py::arg("cameraId"), DOC(dai, CalibrationHandler, getFov))
         .def("getLensPosition", &CalibrationHandler::getLensPosition, py::arg("cameraId"), DOC(dai, CalibrationHandler, getLensPosition))
 
@@ -57,4 +57,4 @@ void CalibrationHandlerBindings::bind(pybind11::module& m){
         .def("setStereoRight", &CalibrationHandler::setStereoRight, py::arg("cameraId"), py::arg("rectifiedRotation"), DOC(dai, CalibrationHandler, setStereoRight));
 
 
-} 
+}

src/CalibrationHandlerBindings.cpp

@@ -30,7 +30,6 @@
 #include "depthai-shared/datatype/RawSystemInformation.hpp"
 #include "depthai-shared/datatype/RawSpatialLocationCalculatorConfig.hpp"
 #include "depthai-shared/datatype/RawSpatialLocations.hpp"
-#include "depthai-shared/datatype/RawSpatialLocationCalculatorConfig.hpp"
 #include "depthai-shared/datatype/RawTracklets.hpp"
 #include "depthai-shared/datatype/RawIMUData.hpp"
 

src/DatatypeBindings.cpp

@@ -203,7 +203,7 @@ void DeviceBindings::bind(pybind11::module& m){
         .def("getQueueEvents", [](Device& d, std::size_t maxNumEvents, std::chrono::microseconds timeout) {
             return deviceGetQueueEventsHelper(d, d.getOutputQueueNames(), maxNumEvents, timeout);
         }, py::arg("maxNumEvents") = std::numeric_limits<std::size_t>::max(), py::arg("timeout") = std::chrono::microseconds(-1), DOC(dai, Device, getQueueEvents, 4))
-        
+
         .def("readCalibration", &Device::readCalibration, DOC(dai, Device, readCalibration))
         .def("flashCalibration", &Device::flashCalibration, py::arg("calibrationDataHandler"), DOC(dai, Device, flashCalibration))
 

src/DeviceBindings.cpp

@@ -9,7 +9,7 @@ void XLinkConnectionBindings::bind(pybind11::module& m){
 
     using namespace dai;
 
-    py::class_<DeviceInfo>(m, "DeviceInfo")
+    py::class_<DeviceInfo>(m, "DeviceInfo", DOC(dai, DeviceInfo))
         .def(py::init<>())
         .def_readwrite("desc", &DeviceInfo::desc)
         .def_readwrite("state", &DeviceInfo::state)
@@ -20,7 +20,7 @@ void XLinkConnectionBindings::bind(pybind11::module& m){
         .def(py::init<>())
         .def_readwrite("protocol", &deviceDesc_t::protocol)
         .def_readwrite("platform", &deviceDesc_t::platform)
-        .def_property("name", 
+        .def_property("name",
             [](deviceDesc_t& o){return std::string(o.name);},
             [](deviceDesc_t& o, std::string n){ std::strncpy(o.name, n.c_str(), std::min(XLINK_MAX_NAME_SIZE,(int) n.size()));}
         )
@@ -52,7 +52,7 @@ void XLinkConnectionBindings::bind(pybind11::module& m){
         .export_values()
         ;
 
-    py::class_<XLinkConnection>(m, "XLinkConnection")
+    py::class_<XLinkConnection>(m, "XLinkConnection", DOC(dai, XLinkConnection))
         .def(py::init<const DeviceInfo&, std::vector<std::uint8_t>>())
         .def(py::init<const DeviceInfo&, std::string>())
         .def(py::init<const DeviceInfo&>())