djsundog
/
circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Cross references in documentation always help

This commit is contained in:
Jeff Epler 2022-08-09 11:47:58 -05:00
parent 5a85b8ab95
commit c74746f052
4 changed files with 16 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
ports/espressif/bindings/esp32_camera/Camera.c
View File

@ -66,7 +66,8 @@
//| This driver requires that the ``CIRCUITPY_RESERVED_PSRAM`` in ``/.env`` be large enough to hold the camera frambuffer(s). Generally, boards with built-in cameras will have a default setting that is large enough. If the constructor raises a MemoryError, this probably indicates the setting is too small and should be increased. //| This driver requires that the ``CIRCUITPY_RESERVED_PSRAM`` in ``/.env`` be large enough to hold the camera frambuffer(s). Generally, boards with built-in cameras will have a default setting that is large enough. If the constructor raises a MemoryError, this probably indicates the setting is too small and should be increased.
//| //|
//| //|
//| .. IMPORTANT: //| .. important::
//|
//| Not all supported sensors have all //| Not all supported sensors have all
//| of the properties listed below. For instance, the //| of the properties listed below. For instance, the
//| OV5640 supports `denoise`, but the //| OV5640 supports `denoise`, but the
@ -558,7 +559,7 @@ MP_PROPERTY_GETSET(esp32_camera_camera_exposure_ctrl_obj,
(mp_obj_t)&esp32_camera_camera_set_exposure_ctrl_obj); (mp_obj_t)&esp32_camera_camera_set_exposure_ctrl_obj);
//| hmirror: bool //| hmirror: bool
//| """When `true` the camera image is mirrored left-to-right""" //| """When `True` the camera image is mirrored left-to-right"""
//| //|
STATIC mp_obj_t esp32_camera_camera_get_hmirror(const mp_obj_t self_in) { STATIC mp_obj_t esp32_camera_camera_get_hmirror(const mp_obj_t self_in) {

5
ports/espressif/bindings/esp32_camera/__init__.c
View File

@ -39,6 +39,11 @@
//| //|
//| This library enables access to any camera sensor supported by the library, //| This library enables access to any camera sensor supported by the library,
//| including OV5640 and OV2640. //| including OV5640 and OV2640.
//|
//| .. seealso::
//|
//| Non-Espressif microcontrollers use the `imagecapture` module together with wrapper libraries such as `adafruit_ov5640 <https://circuitpython.readthedocs.io/projects/ov5640/en/latest/>`_.
//|
//| """ //| """
//| class GrabMode: //| class GrabMode:

2
shared-bindings/imagecapture/ParallelImageCapture.c
View File

@ -47,6 +47,8 @@
//| ) -> None: //| ) -> None:
//| """Create a parallel image capture object //| """Create a parallel image capture object
//| //|
//| This object is usually used with a camera-specific wrapper library such as `adafruit_ov5640 <https://circuitpython.readthedocs.io/projects/ov5640/en/latest/>`_.
//|
//| :param List[microcontroller.Pin] data_pins: The data pins. //| :param List[microcontroller.Pin] data_pins: The data pins.
//| :param microcontroller.Pin clock: The pixel clock input. //| :param microcontroller.Pin clock: The pixel clock input.
//| :param microcontroller.Pin vsync: The vertical sync input, which has a negative-going pulse at the beginning of each frame. //| :param microcontroller.Pin vsync: The vertical sync input, which has a negative-going pulse at the beginning of each frame.

8
shared-bindings/imagecapture/__init__.c
View File

@ -31,9 +31,13 @@
#include "shared-bindings/imagecapture/ParallelImageCapture.h" #include "shared-bindings/imagecapture/ParallelImageCapture.h"
//| """Support for "Parallel capture" interfaces""" //| """Support for "Parallel capture" interfaces
//| //|
//| .. seealso::
//|
//| Espressif microcontrollers use the `esp32_camera` module together.
//|
//| """
STATIC const mp_rom_map_elem_t imagecapture_module_globals_table[] = { STATIC const mp_rom_map_elem_t imagecapture_module_globals_table[] = {
{ MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_imagecapture) }, { MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_imagecapture) },
{ MP_ROM_QSTR(MP_QSTR_ParallelImageCapture), MP_ROM_PTR(&imagecapture_parallelimagecapture_type) }, { MP_ROM_QSTR(MP_QSTR_ParallelImageCapture), MP_ROM_PTR(&imagecapture_parallelimagecapture_type) },