Format port bindings stubs

Author: tannewt

ports/atmel-samd/bindings/samd/Clock.c

@@ -74,6 +74,7 @@ MP_PROPERTY_GETTER(samd_clock_frequency_obj,
 //|     calibration: int
 //|     """Clock calibration. Not all clocks can be calibrated."""
 //|
+//|
 static mp_obj_t samd_clock_get_calibration(mp_obj_t self_in) {
     samd_clock_obj_t *self = MP_OBJ_TO_PTR(self_in);
     return mp_obj_new_int_from_uint(clock_get_calibration(self->type, self->index));

ports/atmel-samd/bindings/samd/__init__.c

@@ -11,6 +11,7 @@
 #include "bindings/samd/Clock.h"
 
 //| """SAMD implementation settings"""
+//|
 
 //| """:mod:`samd.clock` --- samd clock names
 //| --------------------------------------------------------

ports/broadcom/bindings/videocore/Framebuffer.c

@@ -26,6 +26,7 @@
 //|
 //|         A Framebuffer is often used in conjunction with a
 //|         `framebufferio.FramebufferDisplay`."""
+//|
 
 static mp_obj_t videocore_framebuffer_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *all_args) {
     enum { ARG_width, ARG_height, };
@@ -51,6 +52,7 @@ static mp_obj_t videocore_framebuffer_make_new(const mp_obj_type_t *type, size_t
 //|         rgbmatrix instance.  After deinitialization, no further operations
 //|         may be performed."""
 //|         ...
+//|
 static mp_obj_t videocore_framebuffer_deinit(mp_obj_t self_in) {
     videocore_framebuffer_obj_t *self = (videocore_framebuffer_obj_t *)self_in;
     common_hal_videocore_framebuffer_deinit(self);
@@ -79,6 +81,7 @@ MP_PROPERTY_GETTER(videocore_framebuffer_width_obj,
 //|     height: int
 //|     """The height of the display, in pixels"""
 //|
+//|
 static mp_obj_t videocore_framebuffer_get_height(mp_obj_t self_in) {
     videocore_framebuffer_obj_t *self = (videocore_framebuffer_obj_t *)self_in;
     check_for_deinit(self);

ports/espressif/bindings/espcamera/Camera.c

@@ -70,6 +70,7 @@
 //|         :param framebuffer_count: The number of framebuffers (1 for single-buffered and 2 for double-buffered)
 //|         :param grab_mode: When to grab a new frame
 //|         """
+//|
 static mp_obj_t espcamera_camera_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *all_args) {
     enum { ARG_data_pins, ARG_pixel_clock_pin, ARG_vsync_pin, ARG_href_pin, ARG_i2c, ARG_external_clock_pin, ARG_external_clock_frequency, ARG_powerdown_pin, ARG_reset_pin, ARG_pixel_format, ARG_frame_size, ARG_jpeg_quality, ARG_framebuffer_count, ARG_grab_mode, NUM_ARGS };
     static const mp_arg_t allowed_args[] = {
@@ -143,6 +144,7 @@ static mp_obj_t espcamera_camera_make_new(const mp_obj_type_t *type, size_t n_ar
 //|     def deinit(self) -> None:
 //|         """Deinitialises the camera and releases all memory resources for reuse."""
 //|         ...
+//|
 static mp_obj_t espcamera_camera_deinit(mp_obj_t self_in) {
     espcamera_camera_obj_t *self = MP_OBJ_TO_PTR(self_in);
     common_hal_espcamera_camera_deinit(self);
@@ -159,12 +161,14 @@ static void check_for_deinit(espcamera_camera_obj_t *self) {
 //|     def __enter__(self) -> Camera:
 //|         """No-op used by Context Managers."""
 //|         ...
+//|
 //  Provided by context manager helper.
 
 //|     def __exit__(self) -> None:
 //|         """Automatically deinitializes the hardware when exiting a context. See
 //|         :ref:`lifetime-and-contextmanagers` for more info."""
 //|         ...
+//|
 static mp_obj_t espcamera_camera_obj___exit__(size_t n_args, const mp_obj_t *args) {
     (void)n_args;
     return espcamera_camera_deinit(args[0]);
@@ -173,6 +177,7 @@ static MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(espcamera_camera___exit___obj, 4, 4,
 
 //|     frame_available: bool
 //|     """True if a frame is available, False otherwise"""
+//|
 
 static mp_obj_t espcamera_camera_frame_available_get(const mp_obj_t self_in) {
     espcamera_camera_obj_t *self = MP_OBJ_TO_PTR(self_in);
@@ -193,6 +198,7 @@ MP_PROPERTY_GETTER(espcamera_camera_frame_available_obj,
 //|         If `pixel_format` is `PixelFormat.JPEG`, the returned value is a read-only `memoryview`.
 //|         Otherwise, the returned value is a read-only `displayio.Bitmap`.
 //|         """
+//|
 static mp_obj_t espcamera_camera_take(size_t n_args, const mp_obj_t *args) {
     espcamera_camera_obj_t *self = MP_OBJ_TO_PTR(args[0]);
     mp_float_t timeout = n_args < 2 ? MICROPY_FLOAT_CONST(0.25) : mp_obj_get_float(args[1]);
@@ -229,6 +235,7 @@ static MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(espcamera_camera_take_obj, 1, 2, espc
 //|         the other properties to set, they are set together in a single function call.
 //|
 //|         If an argument is unspecified or None, then the setting is unchanged."""
+//|
 
 static mp_obj_t espcamera_camera_reconfigure(mp_uint_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
     espcamera_camera_obj_t *self = MP_OBJ_TO_PTR(pos_args[0]);
@@ -912,6 +919,7 @@ MP_PROPERTY_GETTER(espcamera_camera_grab_mode_obj,
 //|     framebuffer_count: int
 //|     """True if double buffering is used"""
 //|
+//|
 static mp_obj_t espcamera_camera_get_framebuffer_count(const mp_obj_t self_in) {
     espcamera_camera_obj_t *self = MP_OBJ_TO_PTR(self_in);
     check_for_deinit(self);

ports/espressif/bindings/espcamera/__init__.c

@@ -26,6 +26,7 @@
 //|
 //| """
 //|
+//|
 
 //| class GrabMode:
 //|     """Controls when a new frame is grabbed."""
@@ -36,6 +37,7 @@
 //|     LATEST: GrabMode
 //|     """Except when 1 frame buffer is used, queue will always contain the last ``fb_count`` frames"""
 //|
+//|
 
 MAKE_ENUM_VALUE(espcamera_grab_mode_type, grab_mode, WHEN_EMPTY, CAMERA_GRAB_WHEN_EMPTY);
 MAKE_ENUM_VALUE(espcamera_grab_mode_type, grab_mode, LATEST, CAMERA_GRAB_LATEST);
@@ -65,6 +67,7 @@ camera_grab_mode_t validate_grab_mode(mp_obj_t obj, qstr arg_name) {
 //|     JPEG: PixelFormat
 //|     """A compressed format"""
 //|
+//|
 
 MAKE_ENUM_VALUE(espcamera_pixel_format_type, pixel_format, RGB565, PIXFORMAT_RGB565);
 MAKE_ENUM_VALUE(espcamera_pixel_format_type, pixel_format, GRAYSCALE, PIXFORMAT_GRAYSCALE);
@@ -153,6 +156,7 @@ pixformat_t validate_pixel_format(mp_obj_t obj, qstr arg_name) {
 //|     QSXGA: FrameSize
 //|     """2560x1920"""
 //|
+//|
 
 MAKE_ENUM_VALUE(espcamera_frame_size_type, frame_size, R96X96, FRAMESIZE_96X96);
 MAKE_ENUM_VALUE(espcamera_frame_size_type, frame_size, R240X240, FRAMESIZE_240X240);
@@ -222,6 +226,7 @@ framesize_t validate_frame_size(mp_obj_t obj, qstr arg_name) {
 //|     GAIN_64X: GainCeiling
 //|     GAIN_128X: GainCeiling
 //|
+//|
 
 MAKE_ENUM_VALUE(espcamera_gain_ceiling_type, gain_ceiling, GAIN_2X, GAINCEILING_2X);
 MAKE_ENUM_VALUE(espcamera_gain_ceiling_type, gain_ceiling, GAIN_4X, GAINCEILING_4X);

ports/espressif/bindings/espidf/__init__.c

@@ -20,11 +20,13 @@
 //|    that could be implemented by other frameworks. It should only include ESP-IDF specific
 //|    things."""
 //|
+//|
 
 //| def heap_caps_get_total_size() -> int:
 //|     """Return the total size of the ESP-IDF, which includes the CircuitPython heap."""
 //|     ...
 //|
+//|
 
 static mp_obj_t espidf_heap_caps_get_total_size(void) {
     return MP_OBJ_NEW_SMALL_INT(heap_caps_get_total_size(MALLOC_CAP_8BIT));
@@ -35,6 +37,7 @@ MP_DEFINE_CONST_FUN_OBJ_0(espidf_heap_caps_get_total_size_obj, espidf_heap_caps_
 //|     """Return total free memory in the ESP-IDF heap."""
 //|     ...
 //|
+//|
 
 static mp_obj_t espidf_heap_caps_get_free_size(void) {
     return MP_OBJ_NEW_SMALL_INT(heap_caps_get_free_size(MALLOC_CAP_8BIT));
@@ -45,6 +48,7 @@ MP_DEFINE_CONST_FUN_OBJ_0(espidf_heap_caps_get_free_size_obj, espidf_heap_caps_g
 //|     """Return the size of largest free memory block in the ESP-IDF heap."""
 //|     ...
 //|
+//|
 
 static mp_obj_t espidf_heap_caps_get_largest_free_block(void) {
     return MP_OBJ_NEW_SMALL_INT(heap_caps_get_largest_free_block(MALLOC_CAP_8BIT));
@@ -58,6 +62,7 @@ MP_DEFINE_CONST_FUN_OBJ_0(espidf_heap_caps_get_largest_free_block_obj, espidf_he
 //|     layout of data in nvs has changed. The old data will be lost when you perform this operation.
 //|     """
 //|
+//|
 static mp_obj_t espidf_erase_nvs(void) {
     ESP_ERROR_CHECK(nvs_flash_deinit());
     ESP_ERROR_CHECK(nvs_flash_erase());
@@ -84,6 +89,7 @@ static void espidf_exception_print(const mp_print_t *print, mp_obj_t o_in, mp_pr
 //|
 //|     ...
 //|
+//|
 MP_DEFINE_CONST_OBJ_TYPE(
     mp_type_espidf_IDFError,
     MP_QSTR_IDFError,
@@ -99,6 +105,7 @@ MP_DEFINE_CONST_OBJ_TYPE(
 //|
 //|     ...
 //|
+//|
 NORETURN void mp_raise_espidf_MemoryError(void) {
     nlr_raise(mp_obj_new_exception(&mp_type_espidf_MemoryError));
 }
@@ -116,6 +123,7 @@ MP_DEFINE_CONST_OBJ_TYPE(
 //| def get_total_psram() -> int:
 //|     """Returns the number of bytes of psram detected, or 0 if psram is not present or not configured"""
 //|
+//|
 static mp_obj_t espidf_get_total_psram(void) {
     return MP_OBJ_NEW_SMALL_INT(common_hal_espidf_get_total_psram());
 }

ports/espressif/bindings/espnow/ESPNow.c

@@ -41,6 +41,7 @@ static void espnow_check_for_deinit(espnow_obj_t *self) {
 //|             `wifi_phy_rate_t <https://docs.espressif.com/projects/esp-idf/en/release-v4.4/esp32/api-reference/network/esp_wifi.html#_CPPv415wifi_phy_rate_t>`_
 //|         """
 //|         ...
+//|
 static mp_obj_t espnow_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *all_args) {
     enum { ARG_buffer_size, ARG_phy_rate };
     static const mp_arg_t allowed_args[] = {
@@ -71,6 +72,7 @@ static mp_obj_t espnow_make_new(const mp_obj_type_t *type, size_t n_args, size_t
 //|     def deinit(self) -> None:
 //|         """Deinitializes ESP-NOW and releases it for another program."""
 //|         ...
+//|
 static mp_obj_t espnow_deinit(mp_obj_t self_in) {
     espnow_obj_t *self = MP_OBJ_TO_PTR(self_in);
     espnow_check_for_deinit(self);
@@ -82,12 +84,14 @@ static MP_DEFINE_CONST_FUN_OBJ_1(espnow_deinit_obj, espnow_deinit);
 //|     def __enter__(self) -> ESPNow:
 //|         """No-op used by Context Managers."""
 //|         ...
+//|
 //  Provided by context manager helper.
 
 //|     def __exit__(self) -> None:
 //|         """Automatically deinitializes the hardware when exiting a context. See
 //|         :ref:`lifetime-and-contextmanagers` for more info."""
 //|         ...
+//|
 static mp_obj_t espnow_obj___exit__(size_t n_args, const mp_obj_t *args) {
     (void)n_args;
     return espnow_deinit(args[0]);
@@ -109,6 +113,7 @@ static MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(espnow___exit___obj, 4, 4, espnow_obj
 //|         :param Peer peer: Send message to this peer. If `None`, send to all registered peers.
 //|         """
 //|         ...
+//|
 static mp_obj_t espnow_send(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
     enum { ARG_message, ARG_peer };
     static const mp_arg_t allowed_args[] = {
@@ -143,6 +148,7 @@ static MP_DEFINE_CONST_FUN_OBJ_KW(espnow_send_obj, 2, espnow_send);
 //|
 //|         :returns: An `ESPNowPacket` if available in the buffer, otherwise `None`."""
 //|         ...
+//|
 static mp_obj_t espnow_read(mp_obj_t self_in) {
     espnow_obj_t *self = MP_OBJ_TO_PTR(self_in);
     espnow_check_for_deinit(self);
@@ -204,6 +210,7 @@ MP_PROPERTY_GETTER(espnow_read_failure_obj,
 //|
 //|         :param ReadableBuffer pmk: The ESP-NOW Primary Master Key (length = 16 bytes)."""
 //|         ...
+//|
 static mp_obj_t espnow_set_pmk(mp_obj_t self_in, mp_obj_t key) {
     espnow_obj_t *self = MP_OBJ_TO_PTR(self_in);
     espnow_check_for_deinit(self);
@@ -325,6 +332,7 @@ static const mp_stream_p_t espnow_stream_p = {
 //|         """Return the number of `bytes` available to read. Used to implement ``len()``."""
 //|         ...
 //|
+//|
 static mp_obj_t espnow_unary_op(mp_unary_op_t op, mp_obj_t self_in) {
     espnow_obj_t *self = MP_OBJ_TO_PTR(self_in);
     espnow_check_for_deinit(self);

ports/espressif/bindings/espnow/ESPNowPacket.c

@@ -21,6 +21,7 @@
 //|     time: int
 //|     """The time in milliseconds since the device last booted when the packet was received."""
 //|
+//|
 
 const mp_obj_namedtuple_type_t espnow_packet_type_obj = {
     NAMEDTUPLE_TYPE_BASE_AND_SLOTS(MP_QSTR_ESPNowPacket),

ports/espressif/bindings/espnow/Peer.c

@@ -32,6 +32,7 @@
 //|         :param bool encrypted: Whether or not to use encryption.
 //|         """
 //|         ...
+//|
 static mp_obj_t espnow_peer_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *all_args) {
     enum { ARG_mac, ARG_lmk, ARG_channel, ARG_interface, ARG_encrypted };
     static const mp_arg_t allowed_args[] = {
@@ -167,6 +168,7 @@ MP_PROPERTY_GETSET(espnow_peer_interface_obj,
 //|     encrypted: bool
 //|     """Whether or not to use encryption."""
 //|
+//|
 static mp_obj_t espnow_peer_get_encrypted(const mp_obj_t self_in) {
     espnow_peer_obj_t *self = MP_OBJ_TO_PTR(self_in);
     return mp_obj_new_bool(self->peer_info.encrypt);

ports/espressif/bindings/espnow/Peers.c

@@ -21,13 +21,15 @@
 //|     def __init__(self) -> None:
 //|         """You cannot create an instance of `Peers`."""
 //|         ...
+//|
 
 //|     def append(self, peer: Peer) -> None:
 //|         """Append peer.
 //|
 //|         :param Peer peer: The peer object to append.
 //|         """
 //|         ...
+//|
 static mp_obj_t espnow_peers_append(mp_obj_t self_in, mp_obj_t arg) {
     espnow_peer_obj_t *peer = MP_OBJ_TO_PTR(mp_arg_validate_type(arg, &espnow_peer_type, MP_QSTR_Peer));
     CHECK_ESP_RESULT(esp_now_add_peer(&peer->peer_info));
@@ -43,6 +45,7 @@ static MP_DEFINE_CONST_FUN_OBJ_2(espnow_peers_append_obj, espnow_peers_append);
 //|         """
 //|         ...
 //|
+//|
 static mp_obj_t espnow_peers_remove(mp_obj_t self_in, mp_obj_t arg) {
     espnow_peer_obj_t *peer = MP_OBJ_TO_PTR(mp_arg_validate_type(arg, &espnow_peer_type, MP_QSTR_Peer));
     CHECK_ESP_RESULT(esp_now_del_peer(peer->peer_info.peer_addr));