doc: remove fake code snippets

We have API docs now

Fixes #109

Author: laurensvalk

extmod/modbattery.c

@@ -5,23 +5,13 @@
 #include <pberror.h>
 #include <pbdrv/battery.h>
 
-/*
-battery
-    def voltage():
-        """Return battery voltage (mV: millivolt)."""
-*/
 STATIC mp_obj_t battery_voltage(void) {
     uint16_t volt;
     pb_assert(pbdrv_battery_get_voltage_now(PBIO_PORT_SELF, &volt));
     return mp_obj_new_int(volt);
 }
 STATIC MP_DEFINE_CONST_FUN_OBJ_0(battery_voltage_obj, battery_voltage);
 
-/*
-battery
-    def current():
-        """Return battery current (mA: milliampere)."""
-*/
 STATIC mp_obj_t battery_current(void) {
     uint16_t cur;
     pb_assert(pbdrv_battery_get_current_now(PBIO_PORT_SELF, &cur));

extmod/modpupdevices.c

@@ -12,18 +12,6 @@
 #include "modcommon.h"
 #include "pberror.h"
 
-/*
-class ColorAndDistSensor():
-    """Class for the Powered Up ColorAndDistSensor."""
-
-    def __init__(self, port):
-        """Initialize the ColorAndDistSensor.
-
-        Arguments:
-            port -- Port on the hub: Port.A, Port.B, etc.
-        """
-*/
-
 // Class structure for ColorAndDistSensor
 typedef struct _pupdevices_ColorAndDistSensor_obj_t {
     mp_obj_base_t base;
@@ -49,23 +37,12 @@ STATIC uint8_t pupdevices_ColorAndDistSensor_combined_mode(pbio_port_t port, uin
     return data[idx];
 }
 
-/*
-ColorAndDistSensor
-    def __str__(self):
-        """String representation of ColorAndDistSensor object."""
-*/
 STATIC void pupdevices_ColorAndDistSensor_print(const mp_print_t *print,  mp_obj_t self_in, mp_print_kind_t kind) {
     pupdevices_ColorAndDistSensor_obj_t *self = MP_OBJ_TO_PTR(self_in);
     mp_printf(print, qstr_str(MP_QSTR_ColorDistanceSensor));
     mp_printf(print, " on Port.%c",  self->port);
 }
 
-/*
-ColorAndDistSensor
-    def color(self):
-        """Return the detected color.""""
-*/
-
 STATIC mp_obj_t pupdevices_ColorAndDistSensor_color(mp_obj_t self_in) {
     pupdevices_ColorAndDistSensor_obj_t *self = MP_OBJ_TO_PTR(self_in);
     switch(pupdevices_ColorAndDistSensor_combined_mode(self->port, 0)) {
@@ -89,47 +66,25 @@ STATIC mp_obj_t pupdevices_ColorAndDistSensor_color(mp_obj_t self_in) {
 }
 STATIC MP_DEFINE_CONST_FUN_OBJ_1(pupdevices_ColorAndDistSensor_color_obj, pupdevices_ColorAndDistSensor_color);
 
-/*
-ColorAndDistSensor
-    def distance(self):
-        """Returns distance to detected object, ranging from 0 (very close) to 10 (very far)."""
-*/
 STATIC mp_obj_t pupdevices_ColorAndDistSensor_distance(mp_obj_t self_in) {
     pupdevices_ColorAndDistSensor_obj_t *self = MP_OBJ_TO_PTR(self_in);
     return mp_obj_new_int(pupdevices_ColorAndDistSensor_combined_mode(self->port, 1));
 }
 MP_DEFINE_CONST_FUN_OBJ_1(pupdevices_ColorAndDistSensor_distance_obj, pupdevices_ColorAndDistSensor_distance);
 
-
-/*
-ColorAndDistSensor
-    def reflection(self):
-        """Returns surface reflection, ranging from 0 (no reflection) to 100 (very high reflection)."""
-*/
 STATIC mp_obj_t pupdevices_ColorAndDistSensor_reflection(mp_obj_t self_in) {
     pupdevices_ColorAndDistSensor_obj_t *self = MP_OBJ_TO_PTR(self_in);
     return mp_obj_new_int(pupdevices_ColorAndDistSensor_combined_mode(self->port, 3));
 }
 MP_DEFINE_CONST_FUN_OBJ_1(pupdevices_ColorAndDistSensor_reflection_obj, pupdevices_ColorAndDistSensor_reflection);
 
-/*
-ColorAndDistSensor
-    def ambient(self):
-        """Returns ambient light intensity, ranging from 0 (darkness) to 100 (very bright light)."""
-*/
 STATIC mp_obj_t pupdevices_ColorAndDistSensor_ambient(mp_obj_t self_in) {
     pupdevices_ColorAndDistSensor_obj_t *self = MP_OBJ_TO_PTR(self_in);
     pb_assert(pb_iodevice_set_mode(self->port, 4));
     return pb_iodevice_get_values(self->port);
 }
 MP_DEFINE_CONST_FUN_OBJ_1(pupdevices_ColorAndDistSensor_ambient_obj, pupdevices_ColorAndDistSensor_ambient);
 
-
-/*
-ColorAndDistSensor
-    def rgb(self):
-        """Returns surface reflection of red, green, and blue light, each ranging from 0 (no reflection) to 100 (very high reflection)."""
-*/
 STATIC mp_obj_t pupdevices_ColorAndDistSensor_rgb(mp_obj_t self_in) {
     pupdevices_ColorAndDistSensor_obj_t *self = MP_OBJ_TO_PTR(self_in);
     pb_assert(pb_iodevice_set_mode(self->port, 6));

extmod/modtools.c

@@ -16,11 +16,6 @@ STATIC mp_obj_t tools_wait(mp_obj_t arg) {
 }
 MP_DEFINE_CONST_FUN_OBJ_1(tools_wait_obj, tools_wait);
 
-/*
-class StopWatch():
-    """Time the duration of a program or event."""
-*/
-
 // Class structure for StopWatch
 typedef struct _tools_StopWatch_obj_t {
     mp_obj_base_t base;
@@ -30,15 +25,6 @@ typedef struct _tools_StopWatch_obj_t {
     bool running;
 } tools_StopWatch_obj_t;
 
-/*
-StopWatch
-    def reset(self):
-        """Set time to zero and pause."""
-        self.time_start = get_time()
-        self.time_stop = self.time_start
-        self.time_spent_pausing = 0
-        self.running = False
-*/
 STATIC mp_obj_t tools_StopWatch_reset(mp_obj_t self_in) {
     tools_StopWatch_obj_t *self = MP_OBJ_TO_PTR(self_in);
     self->time_start = mp_hal_ticks_ms();
@@ -48,20 +34,6 @@ STATIC mp_obj_t tools_StopWatch_reset(mp_obj_t self_in) {
 }
 STATIC MP_DEFINE_CONST_FUN_OBJ_1(tools_StopWatch_reset_obj, tools_StopWatch_reset);
 
-/*
-StopWatch
-    def time(self):
-        """Get the current time of the stopwatch.
-
-        Returns:
-            int -- time in milliseconds
-
-        """
-        if self.running:
-            return get_time()-self.time_start-self.time_spent_pausing
-        else:
-            return self.time_stop-self.time_start-self.time_spent_pausing
-*/
 STATIC mp_obj_t tools_StopWatch_time(mp_obj_t self_in) {
     tools_StopWatch_obj_t *self = MP_OBJ_TO_PTR(self_in);
     return mp_obj_new_int(
@@ -72,14 +44,6 @@ STATIC mp_obj_t tools_StopWatch_time(mp_obj_t self_in) {
 }
 STATIC MP_DEFINE_CONST_FUN_OBJ_1(tools_StopWatch_time_obj, tools_StopWatch_time);
 
-/*
-StopWatch
-    def pause(self):
-        """Pause the stopwatch."""
-        if self.running:
-            self.running = False
-            self.time_stop = get_time()
-*/
 STATIC mp_obj_t tools_StopWatch_pause(mp_obj_t self_in) {
     tools_StopWatch_obj_t *self = MP_OBJ_TO_PTR(self_in);
     if (self->running) {
@@ -90,14 +54,6 @@ STATIC mp_obj_t tools_StopWatch_pause(mp_obj_t self_in) {
 }
 STATIC MP_DEFINE_CONST_FUN_OBJ_1(tools_StopWatch_pause_obj, tools_StopWatch_pause);
 
-/*
-StopWatch
-    def resume(self):
-        """Resume the stopwatch."""
-        if not self.running:
-            self.running = True
-            self.time_spent_pausing += get_time()-self.time_stop
-*/
 STATIC mp_obj_t tools_StopWatch_resume(mp_obj_t self_in) {
     tools_StopWatch_obj_t *self = MP_OBJ_TO_PTR(self_in);
     if (!self->running) {
@@ -108,13 +64,6 @@ STATIC mp_obj_t tools_StopWatch_resume(mp_obj_t self_in) {
 }
 STATIC MP_DEFINE_CONST_FUN_OBJ_1(tools_StopWatch_resume_obj, tools_StopWatch_resume);
 
-/*
-StopWatch
-    def __init__(self):
-        """Create the StopWatch object, reset it, and start it."""
-        self.reset()
-        self.resume()
-*/
 STATIC mp_obj_t tools_StopWatch_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *args ) {
     // Initialize self
     tools_StopWatch_obj_t *self = m_new_obj(tools_StopWatch_obj_t);
@@ -124,11 +73,6 @@ STATIC mp_obj_t tools_StopWatch_make_new(const mp_obj_type_t *type, size_t n_arg
     return MP_OBJ_FROM_PTR(self);
 }
 
-/*
-StopWatch
-    def __str__(self):
-        """String representation of StopWatch object."""
-*/
 STATIC void tools_StopWatch_print(const mp_print_t *print,  mp_obj_t self_in, mp_print_kind_t kind) {
     mp_printf(print, qstr_str(MP_QSTR_StopWatch));
 }