docs(*): update docs

This commit is contained in:
John Zhao
2019-03-11 13:27:49 +08:00
parent 849e8c80dd
commit 9dcf3acf2a
52 changed files with 569 additions and 3453 deletions

23
docs/api/api.rst Normal file
View File

@@ -0,0 +1,23 @@
API
===
API
---
.. doxygenclass:: mynteye::API
:project: mynteyes
:members:
api::StreamData
---------------
.. doxygenstruct:: mynteye::api::StreamData
:project: mynteyes
:members:
api::MotionData
---------------
.. doxygenstruct:: mynteye::api::MotionData
:project: mynteyes
:members:

30
docs/api/device.rst Normal file
View File

@@ -0,0 +1,30 @@
Device
======
Device
------
.. doxygenclass:: mynteye::Device
:project: mynteyes
:members:
device::Frame
-------------
.. doxygenclass:: mynteye::device::Frame
:project: mynteyes
:members:
device::StreamData
------------------
.. doxygenstruct:: mynteye::device::StreamData
:project: mynteyes
:members:
device::MotionData
------------------
.. doxygenstruct:: mynteye::device::MotionData
:project: mynteyes
:members:

67
docs/api/enums.rst Normal file
View File

@@ -0,0 +1,67 @@
Enums
=====
..
.. doxygengroup:: enumerations
:project: mynteyes
Model
-----
.. doxygenenum:: mynteye::Model
:project: mynteyes
Stream
------
.. doxygenenum:: mynteye::Stream
:project: mynteyes
Capabilities
------------
.. doxygenenum:: mynteye::Capabilities
:project: mynteyes
Info
----
.. doxygenenum:: mynteye::Info
:project: mynteyes
Option
------
.. doxygenenum:: mynteye::Option
:project: mynteyes
Source
------
.. doxygenenum:: mynteye::Source
:project: mynteyes
AddOns
------
.. doxygenenum:: mynteye::AddOns
:project: mynteyes
Format
------
.. doxygenenum:: mynteye::Format
:project: mynteyes
CalibrationModel
----------------
.. doxygenenum:: mynteye::CalibrationModel
:project: mynteyes
DisparityComputingMethod
------------------------
.. doxygenenum:: mynteye::DisparityComputingMethod
:project: mynteyes

75
docs/api/types.rst Normal file
View File

@@ -0,0 +1,75 @@
Types
=====
OptionInfo
----------
.. doxygenstruct:: mynteye::OptionInfo
:project: mynteyes
:members:
Resolution
----------
.. doxygenstruct:: mynteye::Resolution
:project: mynteyes
:members:
StreamRequest
-------------
.. doxygenstruct:: mynteye::StreamRequest
:project: mynteyes
:members:
Intrinsics
----------
IntrinsicsPinhole
~~~~~~~~~~~~~~~~~
.. doxygenstruct:: mynteye::IntrinsicsPinhole
:project: mynteyes
:members:
IntrinsicsEquidistant
~~~~~~~~~~~~~~~~~~~~~
.. doxygenstruct:: mynteye::IntrinsicsEquidistant
:project: mynteyes
:members:
ImuIntrinsics
~~~~~~~~~~~~~
.. doxygenstruct:: mynteye::ImuIntrinsics
:project: mynteyes
:members:
MotionIntrinsics
~~~~~~~~~~~~~~~~~
.. doxygenstruct:: mynteye::MotionIntrinsics
:project: mynteyes
:members:
Extrinsics
----------
.. doxygenstruct:: mynteye::Extrinsics
:project: mynteyes
:members:
ImgData
-------
.. doxygenstruct:: mynteye::ImgData
:project: mynteyes
:members:
ImuData
-------
.. doxygenstruct:: mynteye::ImuData
:project: mynteyes
:members:

32
docs/api/utils.rst Normal file
View File

@@ -0,0 +1,32 @@
Utils
=====
select
------
.. doxygenfunction:: select
:project: mynteyes
select_request
--------------
.. doxygenfunction:: select_request
:project: mynteyes
get_real_exposure_time
----------------------
.. doxygenfunction:: get_real_exposure_time
:project: mynteyes
get_sdk_root_dir
----------------
.. doxygenfunction:: get_sdk_root_dir
:project: mynteyes
get_sdk_install_dir
-------------------
.. doxygenfunction:: get_sdk_install_dir
:project: mynteyes