Did _eve, fontio, framebufferio, and frequencyio

Author: evaherrada

shared-bindings/_eve/__init__.c

@@ -36,25 +36,25 @@
 #include "shared-bindings/util.h"
 #include "supervisor/shared/translate.h"
 
-//| .. currentmodule:: fontio
+//| class BuiltinFont:
+//|     """.. currentmodule:: fontio
 //|
-//| :class:`BuiltinFont` -- A font built into CircuitPython
-//| =========================================================================================
+//|     :class:`BuiltinFont` -- A font built into CircuitPython
+//|     =========================================================================================
 //|
-//| A font built into CircuitPython.
+//|     A font built into CircuitPython."""
 //|
-//| .. class:: BuiltinFont()
-//|
-//|   Creation not supported. Available fonts are defined when CircuitPython is built. See the
-//|   `Adafruit_CircuitPython_Bitmap_Font <https://github.com/adafruit/Adafruit_CircuitPython_Bitmap_Font>`_
-//|   library for dynamically loaded fonts.
+//|     def __init__(self, ):
+//|         """Creation not supported. Available fonts are defined when CircuitPython is built. See the
+//|         `Adafruit_CircuitPython_Bitmap_Font <https://github.com/adafruit/Adafruit_CircuitPython_Bitmap_Font>`_
+//|         library for dynamically loaded fonts."""
+//|         ...
 //|
 
-//|   .. attribute:: bitmap
-//|
-//|     Bitmap containing all font glyphs starting with ASCII and followed by unicode. Use
+//|     bitmap: Any = ...
+//|     """Bitmap containing all font glyphs starting with ASCII and followed by unicode. Use
 //|     `get_glyph` in most cases. This is useful for use with `displayio.TileGrid` and
-//|     `terminalio.Terminal`.
+//|     `terminalio.Terminal`."""
 //|
 STATIC mp_obj_t fontio_builtinfont_obj_get_bitmap(mp_obj_t self_in) {
     fontio_builtinfont_t *self = MP_OBJ_TO_PTR(self_in);
@@ -69,9 +69,9 @@ const mp_obj_property_t fontio_builtinfont_bitmap_obj = {
               (mp_obj_t)&mp_const_none_obj},
 };
 
-//|   .. method:: get_bounding_box()
-//|
-//|     Returns the maximum bounds of all glyphs in the font in a tuple of two values: width, height.
+//|     def get_bounding_box(self, ) -> Any:
+//|         """Returns the maximum bounds of all glyphs in the font in a tuple of two values: width, height."""
+//|         ...
 //|
 STATIC mp_obj_t fontio_builtinfont_obj_get_bounding_box(mp_obj_t self_in) {
     fontio_builtinfont_t *self = MP_OBJ_TO_PTR(self_in);
@@ -81,9 +81,9 @@ STATIC mp_obj_t fontio_builtinfont_obj_get_bounding_box(mp_obj_t self_in) {
 MP_DEFINE_CONST_FUN_OBJ_1(fontio_builtinfont_get_bounding_box_obj, fontio_builtinfont_obj_get_bounding_box);
 
 
-//|   .. method:: get_glyph(codepoint)
-//|
-//|     Returns a `fontio.Glyph` for the given codepoint or None if no glyph is available.
+//|     def get_glyph(self, codepoint: Any) -> Any:
+//|         """Returns a `fontio.Glyph` for the given codepoint or None if no glyph is available."""
+//|         ...
 //|
 STATIC mp_obj_t fontio_builtinfont_obj_get_glyph(mp_obj_t self_in, mp_obj_t codepoint_obj) {
     fontio_builtinfont_t *self = MP_OBJ_TO_PTR(self_in);

shared-bindings/fontio/BuiltinFont.c

@@ -28,23 +28,24 @@
 
 #include <stdint.h>
 
-//| .. currentmodule:: fontio
+//| class Glyph:
+//|     """.. currentmodule:: fontio
 //|
-//| :class:`Glyph` -- Storage of glyph info
-//| ==========================================================================
+//|     :class:`Glyph` -- Storage of glyph info
+//|     =========================================================================="""
 //|
-//| .. class:: Glyph(bitmap, tile_index, width, height, dx, dy, shift_x, shift_y)
+//|     def __init__(self, bitmap: displayio.Bitmap, tile_index: int, width: int, height: int, dx: int, dy: int, shift_x: int, shift_y: int):
+//|         """Named tuple used to capture a single glyph and its attributes.
 //|
-//|   Named tuple used to capture a single glyph and its attributes.
-//|
-//|   :param displayio.Bitmap bitmap: the bitmap including the glyph
-//|   :param int tile_index: the tile index within the bitmap
-//|   :param int width: the width of the glyph's bitmap
-//|   :param int height: the height of the glyph's bitmap
-//|   :param int dx: x adjustment to the bitmap's position
-//|   :param int dy: y adjustment to the bitmap's position
-//|   :param int shift_x: the x difference to the next glyph
-//|   :param int shift_y: the y difference to the next glyph
+//|         :param displayio.Bitmap bitmap: the bitmap including the glyph
+//|         :param int tile_index: the tile index within the bitmap
+//|         :param int width: the width of the glyph's bitmap
+//|         :param int height: the height of the glyph's bitmap
+//|         :param int dx: x adjustment to the bitmap's position
+//|         :param int dy: y adjustment to the bitmap's position
+//|         :param int shift_x: the x difference to the next glyph
+//|         :param int shift_y: the y difference to the next glyph"""
+//|         ...
 //|
 const mp_obj_namedtuple_type_t fontio_glyph_type = {
     .base = {

shared-bindings/fontio/Glyph.c

@@ -33,7 +33,7 @@
 #include "shared-bindings/fontio/BuiltinFont.h"
 #include "shared-bindings/fontio/Glyph.h"
 
-//| :mod:`fontio` --- Core font related data structures
+//| """:mod:`fontio` --- Core font related data structures
 //| =========================================================================
 //|
 //| .. module:: fontio
@@ -48,7 +48,7 @@
 //|     :maxdepth: 3
 //|
 //|     BuiltinFont
-//|     Glyph
+//|     Glyph"""
 //|
 
 STATIC const mp_rom_map_elem_t fontio_module_globals_table[] = {

shared-bindings/fontio/__init__.c

@@ -40,23 +40,24 @@
 #include "shared-module/displayio/__init__.h"
 #include "supervisor/shared/translate.h"
 
-//| .. currentmodule:: framebufferio
+//| class FramebufferDisplay:
+//|     """.. currentmodule:: framebufferio
 //|
-//| :class:`FramebufferDisplay` -- Manage updating a display with framebuffer in RAM
-//| ================================================================================
+//|     :class:`FramebufferDisplay` -- Manage updating a display with framebuffer in RAM
+//|     ================================================================================
 //|
-//| This initializes a display and connects it into CircuitPython. Unlike other
-//| objects in CircuitPython, Display objects live until `displayio.release_displays()`
-//| is called. This is done so that CircuitPython can use the display itself.
+//|     This initializes a display and connects it into CircuitPython. Unlike other
+//|     objects in CircuitPython, Display objects live until `displayio.release_displays()`
+//|     is called. This is done so that CircuitPython can use the display itself."""
 //|
-//| .. class:: FramebufferDisplay(framebuffer, *, rotation=0, auto_refresh=True)
+//|     def __init__(self, framebuffer: Any, *, rotation: int = 0, auto_refresh: bool = True):
+//|         """Create a Display object with the given framebuffer (a buffer, array, ulab.array, etc)
 //|
-//|   Create a Display object with the given framebuffer (a buffer, array, ulab.array, etc)
-//|
-//|   :param framebuffer: The framebuffer that the display is connected to
-//|   :type framebuffer: any core object implementing the framebuffer protocol
-//|   :param bool auto_refresh: Automatically refresh the screen
-//|   :param int rotation: The rotation of the display in degrees clockwise. Must be in 90 degree increments (0, 90, 180, 270)
+//|         :param framebuffer: The framebuffer that the display is connected to
+//|         :type framebuffer: any core object implementing the framebuffer protocol
+//|         :param bool auto_refresh: Automatically refresh the screen
+//|         :param int rotation: The rotation of the display in degrees clockwise. Must be in 90 degree increments (0, 90, 180, 270)"""
+//|         ...
 //|
 STATIC mp_obj_t framebufferio_framebufferdisplay_make_new(const mp_obj_type_t *type, size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
     enum { ARG_framebuffer, ARG_rotation, ARG_auto_refresh, NUM_ARGS };
@@ -96,12 +97,12 @@ static framebufferio_framebufferdisplay_obj_t* native_display(mp_obj_t display_o
     return MP_OBJ_TO_PTR(native_display);
 }
 
-//|   .. method:: show(group)
-//|
-//|     Switches to displaying the given group of layers. When group is None, the default
-//|     CircuitPython terminal will be shown.
+//|     def show(self, group: Group) -> Any:
+//|         """Switches to displaying the given group of layers. When group is None, the default
+//|         CircuitPython terminal will be shown.
 //|
-//|     :param Group group: The group to show.
+//|         :param Group group: The group to show."""
+//|         ...
 //|
 STATIC mp_obj_t framebufferio_framebufferdisplay_obj_show(mp_obj_t self_in, mp_obj_t group_in) {
     framebufferio_framebufferdisplay_obj_t *self = native_display(self_in);
@@ -118,21 +119,21 @@ STATIC mp_obj_t framebufferio_framebufferdisplay_obj_show(mp_obj_t self_in, mp_o
 }
 MP_DEFINE_CONST_FUN_OBJ_2(framebufferio_framebufferdisplay_show_obj, framebufferio_framebufferdisplay_obj_show);
 
-//|   .. method:: refresh(*, target_frames_per_second=60, minimum_frames_per_second=1)
-//|
-//|     When auto refresh is off, waits for the target frame rate and then refreshes the display,
-//|     returning True. If the call has taken too long since the last refresh call for the given
-//|     target frame rate, then the refresh returns False immediately without updating the screen to
-//|     hopefully help getting caught up.
+//|     def refresh(self, *, target_frames_per_second: int = 60, minimum_frames_per_second: int = 1) -> Any:
+//|         """When auto refresh is off, waits for the target frame rate and then refreshes the display,
+//|         returning True. If the call has taken too long since the last refresh call for the given
+//|         target frame rate, then the refresh returns False immediately without updating the screen to
+//|         hopefully help getting caught up.
 //|
-//|     If the time since the last successful refresh is below the minimum frame rate, then an
-//|     exception will be raised. Set minimum_frames_per_second to 0 to disable.
+//|         If the time since the last successful refresh is below the minimum frame rate, then an
+//|         exception will be raised. Set minimum_frames_per_second to 0 to disable.
 //|
-//|     When auto refresh is on, updates the display immediately. (The display will also update
-//|     without calls to this.)
+//|         When auto refresh is on, updates the display immediately. (The display will also update
+//|         without calls to this.)
 //|
-//|   :param int target_frames_per_second: How many times a second `refresh` should be called and the screen updated.
-//|   :param int minimum_frames_per_second: The minimum number of times the screen should be updated per second.
+//|         :param int target_frames_per_second: How many times a second `refresh` should be called and the screen updated.
+//|         :param int minimum_frames_per_second: The minimum number of times the screen should be updated per second."""
+//|         ...
 //|
 STATIC mp_obj_t framebufferio_framebufferdisplay_obj_refresh(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
     enum { ARG_target_frames_per_second, ARG_minimum_frames_per_second };
@@ -153,9 +154,8 @@ STATIC mp_obj_t framebufferio_framebufferdisplay_obj_refresh(size_t n_args, cons
 }
 MP_DEFINE_CONST_FUN_OBJ_KW(framebufferio_framebufferdisplay_refresh_obj, 1, framebufferio_framebufferdisplay_obj_refresh);
 
-//|   .. attribute:: auto_refresh
-//|
-//|     True when the display is refreshed automatically.
+//|     auto_refresh: Any = ...
+//|     """True when the display is refreshed automatically."""
 //|
 STATIC mp_obj_t framebufferio_framebufferdisplay_obj_get_auto_refresh(mp_obj_t self_in) {
     framebufferio_framebufferdisplay_obj_t *self = native_display(self_in);
@@ -179,11 +179,10 @@ const mp_obj_property_t framebufferio_framebufferdisplay_auto_refresh_obj = {
               (mp_obj_t)&mp_const_none_obj},
 };
 
-//|   .. attribute:: brightness
-//|
-//|     The brightness of the display as a float. 0.0 is off and 1.0 is full brightness. When
+//|     brightness: Any = ...
+//|     """The brightness of the display as a float. 0.0 is off and 1.0 is full brightness. When
 //|     `auto_brightness` is True, the value of `brightness` will change automatically.
-//|     If `brightness` is set, `auto_brightness` will be disabled and will be set to False.
+//|     If `brightness` is set, `auto_brightness` will be disabled and will be set to False."""
 //|
 STATIC mp_obj_t framebufferio_framebufferdisplay_obj_get_brightness(mp_obj_t self_in) {
     framebufferio_framebufferdisplay_obj_t *self = native_display(self_in);
@@ -217,12 +216,11 @@ const mp_obj_property_t framebufferio_framebufferdisplay_brightness_obj = {
               (mp_obj_t)&mp_const_none_obj},
 };
 
-//|   .. attribute:: auto_brightness
-//|
-//|     True when the display brightness is adjusted automatically, based on an ambient
+//|     auto_brightness: Any = ...
+//|     """True when the display brightness is adjusted automatically, based on an ambient
 //|     light sensor or other method. Note that some displays may have this set to True by default,
 //|     but not actually implement automatic brightness adjustment. `auto_brightness` is set to False
-//|     if `brightness` is set manually.
+//|     if `brightness` is set manually."""
 //|
 STATIC mp_obj_t framebufferio_framebufferdisplay_obj_get_auto_brightness(mp_obj_t self_in) {
     framebufferio_framebufferdisplay_obj_t *self = native_display(self_in);
@@ -249,9 +247,8 @@ const mp_obj_property_t framebufferio_framebufferdisplay_auto_brightness_obj = {
               (mp_obj_t)&mp_const_none_obj},
 };
 
-//|   .. attribute:: width
-//|
-//|	Gets the width of the framebuffer
+//|     width: Any = ...
+//|	    """Gets the width of the framebuffer"""
 //|
 STATIC mp_obj_t framebufferio_framebufferdisplay_obj_get_width(mp_obj_t self_in) {
     framebufferio_framebufferdisplay_obj_t *self = native_display(self_in);
@@ -266,9 +263,8 @@ const mp_obj_property_t framebufferio_framebufferdisplay_width_obj = {
               (mp_obj_t)&mp_const_none_obj},
 };
 
-//|   .. attribute:: height
-//|
-//|	Gets the height of the framebuffer
+//|     height: Any = ...
+//|	    """Gets the height of the framebuffer"""
 //|
 STATIC mp_obj_t framebufferio_framebufferdisplay_obj_get_height(mp_obj_t self_in) {
     framebufferio_framebufferdisplay_obj_t *self = native_display(self_in);
@@ -283,9 +279,8 @@ const mp_obj_property_t framebufferio_framebufferdisplay_height_obj = {
               (mp_obj_t)&mp_const_none_obj},
 };
 
-//|   .. attribute:: rotation
-//|
-//|     The rotation of the display as an int in degrees.
+//|     rotation: Any = ...
+//|     """The rotation of the display as an int in degrees."""
 //|
 STATIC mp_obj_t framebufferio_framebufferdisplay_obj_get_rotation(mp_obj_t self_in) {
     framebufferio_framebufferdisplay_obj_t *self = native_display(self_in);
@@ -307,9 +302,8 @@ const mp_obj_property_t framebufferio_framebufferdisplay_rotation_obj = {
               (mp_obj_t)&mp_const_none_obj},
 };
 
-//|   .. attribute:: framebuffer
-//|
-//|	The framebuffer being used by the display
+//|     framebuffer: Any = ...
+//|	    """The framebuffer being used by the display"""
 //|
 //|
 STATIC mp_obj_t framebufferio_framebufferdisplay_obj_get_framebuffer(mp_obj_t self_in) {
@@ -326,12 +320,13 @@ const mp_obj_property_t framebufferio_framebufferframebuffer_obj = {
 };
 
 
-//|   .. method:: fill_row(y, buffer)
+//|     def fill_row(self, y: int, buffer: bytearray) -> Any:
+//|         """Extract the pixels from a single row
 //|
-//|     Extract the pixels from a single row
+//|         :param int y: The top edge of the area
+//|         :param bytearray buffer: The buffer in which to place the pixel data"""
+//|         ...
 //|
-//|     :param int y: The top edge of the area
-//|     :param bytearray buffer: The buffer in which to place the pixel data
 STATIC mp_obj_t framebufferio_framebufferdisplay_obj_fill_row(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
     enum { ARG_y, ARG_buffer };
     static const mp_arg_t allowed_args[] = {

shared-bindings/framebufferio/FramebufferDisplay.c

@@ -28,7 +28,7 @@
 #include "shared-bindings/framebufferio/__init__.h"
 #include "shared-bindings/framebufferio/FramebufferDisplay.h"
 
-//| :mod:`framebufferio` --- Native framebuffer display driving
+//| """:mod:`framebufferio` --- Native framebuffer display driving
 //| =========================================================================
 //|
 //| .. module:: framebufferio
@@ -46,7 +46,7 @@
 //| .. toctree::
 //|     :maxdepth: 3
 //|
-//|     FramebufferDisplay
+//|     FramebufferDisplay"""
 //|
 
 #if CIRCUITPY_FRAMEBUFFERIO