autodoc: Removed autodoc directive from py swig

Since UPM uses doxy2swig, there is no need for the swig interface
file autodoc for python.

Also, turned on the doxy2swig --quiet switch which cleans up the build
log a tiny bit.

This removes a redundant chunk of documentation from python modules
(per each function).

Old:

           def pH(self, samples=15):
         +->   """
         |     pH(DFRPH self, unsigned int samples=15) -> float
         |
         |     Parameters
         |     ----------
     swig|     samples: unsigned int
         |
         |     pH(DFRPH self) -> float
         |
         |     Parameters
         |     ----------
         +->   self: upm::DFRPH *

         +->   float pH(unsigned int
         |     samples=15)
         |
         |     Take a number of samples and return the detected pH value. The default
         |     number of samples is 15.
         |
doxy2swig|     Parameters:
         |     -----------
         |
         |     samples:  The number of samples to average over, default 15
         |
         |     The pH value detected
         |     """
         +->   return _pyupm_dfrph.DFRPH_pH(self, samples)

   New:

           def pH(self, samples=15):
         +->    """
         |      float pH(unsigned int
         |      samples=15)
         |
         |      Take a number of samples and return the detected pH value. The default
         |      number of samples is 15.
         |
doxy2swig|      Parameters:
         |      -----------
         |
         |      samples:  The number of samples to average over, default 15
         |
         |      The pH value detected
         +->    """

Signed-off-by: Noel Eck <noel.eck@intel.com>
This commit is contained in:
Noel Eck 2017-07-13 15:13:25 -07:00
parent 5e7a8b41a3
commit 01036f7dae
215 changed files with 8 additions and 440 deletions

View File

@ -778,7 +778,7 @@ if (BUILDDOC AND BUILDSWIGPYTHON)
# doxy2swig the doxygen output
add_custom_target (pyupm_doxy2swig ALL
COMMAND ${PYTHON2_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/doxy2swig.py
${CMAKE_BINARY_DIR}/xml/index.xml
${CMAKE_BINARY_DIR}/xml/index.xml --quiet
${CMAKE_CURRENT_BINARY_DIR}/pyupm_doxy2swig.i
DEPENDS doc)
# BUILDDOC not set but still building python modules, generate an empty

View File

@ -3,8 +3,6 @@
%module pyupm_a110x
%include "../upm.i"
%feature("autodoc", "3");
%include "a110x.hpp"
%{
#include "a110x.hpp"

View File

@ -3,8 +3,6 @@
%module pyupm_abp
%include "../upm.i"
%feature("autodoc", "3");
%include "abp.hpp"
%{
#include "abp.hpp"

View File

@ -3,8 +3,6 @@
%module pyupm_ad8232
%include "../upm.i"
%feature("autodoc", "3");
%include "ad8232.hpp"
%{
#include "ad8232.hpp"

View File

@ -3,8 +3,6 @@
%module pyupm_adafruitms1438
%include "../upm.i"
%feature("autodoc", "3");
#ifdef DOXYGEN
%include "adafruitms1438_doc.i"
#endif

View File

@ -3,8 +3,6 @@
%module pyupm_adafruitss
%include "../upm.i"
%feature("autodoc", "3");
%include "adafruitss.hpp"
%{
#include "adafruitss.hpp"

View File

@ -3,8 +3,6 @@
%module pyupm_adc121c021
%include "../upm.i"
%feature("autodoc", "3");
#ifdef DOXYGEN
%include "adc121c021_doc.i"
#endif

View File

@ -3,8 +3,6 @@
%module pyupm_ads1x15
%include "../upm.i"
%feature("autodoc", "3");
%include "iModuleStatus.hpp"
%include "iADC.hpp"

View File

@ -7,8 +7,6 @@
%pointer_functions(int, intPointer);
%pointer_functions(float, floatPointer);
%feature("autodoc", "3");
%include "adxl335.hpp"
%{
#include "adxl335.hpp"

View File

@ -13,8 +13,6 @@
$result = SWIG_NewPointerObj(SWIG_as_voidptr(result), SWIGTYPE_p_floatArray, 0 | 0 );
}
%feature("autodoc", "3");
#ifdef DOXYGEN
%include "adxl345_doc.i"
#endif

View File

@ -3,8 +3,6 @@
%module pyupm_adxrs610
%include "../upm.i"
%feature("autodoc", "3");
%include "adxrs610.hpp"
%{
#include "adxrs610.hpp"

View File

@ -3,8 +3,6 @@
%module pyupm_am2315
%include "../upm.i"
%feature("autodoc", "3");
#ifdef DOXYGEN
%include "am2315_doc.i"
#endif

View File

@ -1,13 +1,11 @@
// Include doxygen-generated documentation
%include "pyupm_doxy2swig.i"
%module pyupm_apa102
%include "../upm.i"
%feature("autodoc", "3");
// setLeds
// setLeds
%typemap(in) (uint8_t *colors) {
if (PyByteArray_Check($input)) {
$1 = (uint8_t*) PyByteArray_AsString($input);
@ -16,10 +14,10 @@
return NULL;
}
}
%include "apa102.hpp"
%{
#include "apa102.hpp"
%}

View File

@ -3,8 +3,6 @@
%module pyupm_apds9002
%include "../upm.i"
%feature("autodoc", "3");
%include "apds9002.hpp"
%{
#include "apds9002.hpp"

View File

@ -3,8 +3,6 @@
// Include doxygen-generated documentation
%include "pyupm_doxy2swig.i"
%feature("autodoc", "3");
%include "apds9930.hpp"
%{
#include "apds9930.hpp"

View File

@ -3,8 +3,6 @@
%module pyupm_at42qt1070
%include "../upm.i"
%feature("autodoc", "3");
#ifdef DOXYGEN
%include "at42qt1070_doc.i"
#endif

View File

@ -5,8 +5,6 @@
%include "stdint.i"
%include "cpointer.i"
%feature("autodoc", "3");
%pointer_functions(float, floatp);
%include "bacnetmstp.hpp"

View File

@ -4,8 +4,6 @@
%include "../upm.i"
%include "std_string.i"
%feature("autodoc", "3");
%include "bh1750_defs.h"
%include "bh1750.hpp"
%{

View File

@ -3,8 +3,6 @@
%module pyupm_biss0001
%include "../upm.i"
%feature("autodoc", "3");
%include "biss0001.hpp"
%{
#include "biss0001.hpp"

View File

@ -6,8 +6,6 @@
%include "stdint.i"
%feature("autodoc", "3");
%pointer_functions(float, floatp);
%include "bma220.hpp"

View File

@ -9,8 +9,6 @@
%pointer_functions(int, intp);
%pointer_functions(float, floatp);
%feature("autodoc", "3");
#ifdef DOXYGEN
%include "bma250e_doc.i"
#endif

View File

@ -9,8 +9,6 @@
%pointer_functions(int, intp);
%pointer_functions(float, floatp);
%feature("autodoc", "3");
#ifdef DOXYGEN
%include "bmg160_doc.i"
#endif

View File

@ -7,8 +7,6 @@
%include "stdint.i"
%feature("autodoc", "3");
%pointer_functions(float, floatp);
%include "bmi160_defs.h"

View File

@ -9,8 +9,6 @@
%pointer_functions(int, intp);
%pointer_functions(float, floatp);
%feature("autodoc", "3");
#ifdef DOXYGEN
%include "bmm150_doc.i"
#endif

View File

@ -6,8 +6,6 @@
%include "stdint.i"
%feature("autodoc", "3");
#ifdef DOXYGEN
%include "bmp280_doc.i"
#endif

View File

@ -9,8 +9,6 @@
%pointer_functions(int, intp);
%pointer_functions(float, floatp);
%feature("autodoc", "3");
#ifdef DOXYGEN
%include "bmx055_doc.i"
#endif

View File

@ -13,8 +13,6 @@
%pointer_functions(float, floatp);
%feature("autodoc", "3");
#ifdef DOXYGEN
%include "bno055_doc.i"
#endif

View File

@ -3,8 +3,6 @@
%module pyupm_button
%include "../upm.i"
%feature("autodoc", "3");
%include "button.hpp"
%{
#include "button.hpp"

View File

@ -3,8 +3,6 @@
%module pyupm_buzzer
%include "../upm.i"
%feature("autodoc", "3");
%include "buzzer_tones.h"
%include "buzzer.hpp"
%{

View File

@ -3,8 +3,6 @@
%module pyupm_cjq4435
%include "../upm.i"
%feature("autodoc", "3");
%include "cjq4435.hpp"
%{
#include "cjq4435.hpp"

View File

@ -3,8 +3,6 @@
%module pyupm_collision
%include "../upm.i"
%feature("autodoc", "3");
%include "collision.hpp"
%{
#include "collision.hpp"

View File

@ -5,8 +5,6 @@
%include "../carrays_int16_t.i"
%include "stdint.i"
%feature("autodoc", "3");
#ifdef DOXYGEN
%include "curieupm_doc.i"
#endif

View File

@ -4,8 +4,6 @@
%include "../upm.i"
%include "std_string.i"
%feature("autodoc", "3");
%{
#include "cwlsxxa.hpp"
%}

View File

@ -9,8 +9,6 @@
%pointer_functions(int, intp);
%pointer_functions(float, floatp);
%feature("autodoc", "3");
%include "dfrec.hpp"
%{
#include "dfrec.hpp"

View File

@ -9,8 +9,6 @@
%pointer_functions(int, intp);
%pointer_functions(float, floatp);
%feature("autodoc", "3");
%include "dfrorp.hpp"
%{
#include "dfrorp.hpp"

View File

@ -3,8 +3,6 @@
%module pyupm_dfrph
%include "../upm.i"
%feature("autodoc", "3");
%include "dfrph.hpp"
%{
#include "dfrph.hpp"

View File

@ -3,8 +3,6 @@
%module pyupm_ds1307
%include "../upm.i"
%feature("autodoc", "3");
#ifdef DOXYGEN
%include "ds1307_doc.i"
#endif

View File

@ -4,8 +4,6 @@
%include "pyupm_doxy2swig.i"
%feature("autodoc", "3");
%include "iModuleStatus.hpp"
%include "iLightController.hpp"
%include "ds1808lc.hpp"

View File

@ -6,8 +6,6 @@
%include "carrays.i"
%include "std_string.i"
%feature("autodoc", "3");
%include "ds18b20_defs.h"
%include "ds18b20.hpp"
%{

View File

@ -6,8 +6,6 @@
%include "carrays.i"
%include "std_string.i"
%feature("autodoc", "3");
%{
#include "ds2413.hpp"
%}

View File

@ -4,8 +4,6 @@
%include "../upm.i"
%include "stdint.i"
%feature("autodoc", "3");
%include "bacnetmstp.hpp"
%include "bacnetutil.hpp"
%include "e50hx.hpp"

View File

@ -4,8 +4,6 @@
%include "../upm.i"
%include "std_string.i"
%feature("autodoc", "3");
%include "ecezo_defs.h"
%include "ecezo.hpp"
%{

View File

@ -5,8 +5,6 @@
%include "stdint.i"
%feature("autodoc", "3");
%include "ecs1030.hpp"
%{
#include "ecs1030.hpp"

View File

@ -3,8 +3,6 @@
%module pyupm_ehr
%include "../upm.i"
%feature("autodoc", "3");
%include "ehr.hpp"
%{
#include "ehr.hpp"

View File

@ -3,8 +3,6 @@
%module pyupm_eldriver
%include "../upm.i"
%feature("autodoc", "3");
%include "eldriver.hpp"
%{
#include "eldriver.hpp"

View File

@ -3,8 +3,6 @@
%module pyupm_electromagnet
%include "../upm.i"
%feature("autodoc", "3");
%include "electromagnet.hpp"
%{
#include "electromagnet.hpp"

View File

@ -3,8 +3,6 @@
%module pyupm_emg
%include "../upm.i"
%feature("autodoc", "3");
%include "emg.hpp"
%{
#include "emg.hpp"

View File

@ -3,8 +3,6 @@
%module pyupm_enc03r
%include "../upm.i"
%feature("autodoc", "3");
%include "enc03r.hpp"
%{
#include "enc03r.hpp"

View File

@ -3,8 +3,6 @@
%module pyupm_flex
%include "../upm.i"
%feature("autodoc", "3");
%include "flex.hpp"
%{
#include "flex.hpp"

View File

@ -4,8 +4,6 @@
%include "../upm.i"
%include "../carrays_uint16_t.i"
%feature("autodoc", "3");
%include "gas.hpp"
%{
#include "gas.hpp"

View File

@ -3,8 +3,6 @@
%module pyupm_gp2y0a
%include "../upm.i"
%feature("autodoc", "3");
%include "gp2y0a.hpp"
%{
#include "gp2y0a.hpp"

View File

@ -5,8 +5,6 @@
%include "carrays.i"
%include "std_string.i"
%feature("autodoc", "3");
%{
#include "gprs.hpp"
%}

View File

@ -3,8 +3,6 @@
%module pyupm_grove
%include "../upm.i"
%feature("autodoc", "3");
%include "grove.hpp"
%{
#include "grove.hpp"

View File

@ -3,8 +3,6 @@
%module pyupm_grovecollision
%include "../upm.i"
%feature("autodoc", "3");
%include "grovecollision.hpp"
%{
#include "grovecollision.hpp"

View File

@ -3,8 +3,6 @@
%module pyupm_groveehr
%include "../upm.i"
%feature("autodoc", "3");
%include "groveehr.hpp"
%{
#include "groveehr.hpp"

View File

@ -3,8 +3,6 @@
%module pyupm_groveeldriver
%include "../upm.i"
%feature("autodoc", "3");
%include "groveeldriver.hpp"
%{
#include "groveeldriver.hpp"

View File

@ -3,8 +3,6 @@
%module pyupm_groveelectromagnet
%include "../upm.i"
%feature("autodoc", "3");
%include "groveelectromagnet.hpp"
%{
#include "groveelectromagnet.hpp"

View File

@ -3,8 +3,6 @@
%module pyupm_groveemg
%include "../upm.i"
%feature("autodoc", "3");
%include "groveemg.hpp"
%{
#include "groveemg.hpp"

View File

@ -5,8 +5,6 @@
%include "carrays.i"
%include "std_string.i"
%feature("autodoc", "3");
%{
#include "grovegprs.hpp"
%}

View File

@ -3,8 +3,6 @@
%module pyupm_grovegsr
%include "../upm.i"
%feature("autodoc", "3");
%include "grovegsr.hpp"
%{
#include "grovegsr.hpp"

View File

@ -3,8 +3,6 @@
%module pyupm_grovelinefinder
%include "../upm.i"
%feature("autodoc", "3");
%include "grovelinefinder.hpp"
%{
#include "grovelinefinder.hpp"

View File

@ -3,8 +3,6 @@
%module pyupm_grovemd
%include "../upm.i"
%feature("autodoc", "3");
#ifdef DOXYGEN
%include "grovemd_doc.i"
#endif

View File

@ -3,8 +3,6 @@
%module pyupm_grovemoisture
%include "../upm.i"
%feature("autodoc", "3");
%include "grovemoisture.hpp"
%{
#include "grovemoisture.hpp"

View File

@ -3,8 +3,6 @@
%module pyupm_groveo2
%include "../upm.i"
%feature("autodoc", "3");
%include "groveo2.hpp"
%{
#include "groveo2.hpp"

View File

@ -3,8 +3,6 @@
%module pyupm_grovescam
%include "../upm.i"
%feature("autodoc", "3");
%{
#include "grovescam.hpp"
%}

View File

@ -3,8 +3,6 @@
%module pyupm_grovespeaker
%include "../upm.i"
%feature("autodoc", "3");
%include "grovespeaker.hpp"
%{
#include "grovespeaker.hpp"

View File

@ -3,8 +3,6 @@
%module pyupm_groveultrasonic
%include "../upm.i"
%feature("autodoc", "3");
%include "groveultrasonic.hpp"
%{
#include "groveultrasonic.hpp"

View File

@ -3,8 +3,6 @@
%module pyupm_grovevdiv
%include "../upm.i"
%feature("autodoc", "3");
%include "grovevdiv.hpp"
%{
#include "grovevdiv.hpp"

View File

@ -3,8 +3,6 @@
%module pyupm_grovewater
%include "../upm.i"
%feature("autodoc", "3");
%include "grovewater.hpp"
%{
#include "grovewater.hpp"

View File

@ -3,8 +3,6 @@
%module pyupm_grovewfs
%include "../upm.i"
%feature("autodoc", "3");
%include "grovewfs.hpp"
%{
#include "grovewfs.hpp"

View File

@ -3,8 +3,6 @@
%module pyupm_gsr
%include "../upm.i"
%feature("autodoc", "3");
%include "gsr.hpp"
%{
#include "gsr.hpp"

View File

@ -3,8 +3,6 @@
%module pyupm_guvas12d
%include "../upm.i"
%feature("autodoc", "3");
%include "guvas12d.hpp"
%{
#include "guvas12d.hpp"

View File

@ -8,8 +8,6 @@
%pointer_functions(int, intp);
%pointer_functions(float, floatp);
%feature("autodoc", "3");
#ifdef DOXYGEN
%include "h3lis331dl_doc.i"
#endif

View File

@ -4,8 +4,6 @@
%include "../upm.i"
%include "stdint.i"
%feature("autodoc", "3");
%include "h803x.hpp"
%{
#include "h803x.hpp"

View File

@ -3,8 +3,6 @@
%module pyupm_hcsr04
%include "../upm.i"
%feature("autodoc", "3");
%include "hcsr04.h"
%include "hcsr04.hpp"
%{

View File

@ -3,8 +3,6 @@
%module pyupm_hdc1000
%include "../upm.i"
%feature("autodoc", "3");
#ifdef DOXYGEN
%include "hdc1000_doc.i"
#endif

View File

@ -4,8 +4,6 @@
%include "../upm.i"
%include "std_string.i"
%feature("autodoc", "3");
%{
#include "hdxxvxta.hpp"
%}

View File

@ -4,8 +4,6 @@
%include "../upm.i"
%include "std_string.i"
%feature("autodoc", "3");
%include "hka5.hpp"
%{
#include "hka5.hpp"

View File

@ -3,8 +3,6 @@
// Include doxygen-generated documentation
%include "pyupm_doxy2swig.i"
%feature("autodoc", "3");
%include "hlg150h.hpp"
%{
#include "hlg150h.hpp"

View File

@ -4,8 +4,6 @@
%include "../upm.i"
%include "carrays.i"
%feature("autodoc", "3");
%{
#include "hm11.hpp"
speed_t int_B9600 = B9600;

View File

@ -4,8 +4,6 @@
%include "../upm.i"
%include "../carrays_int16_t.i"
%feature("autodoc", "3");
#ifdef DOXYGEN
%include "hmc5883l_doc.i"
#endif

View File

@ -9,8 +9,6 @@
%rename("getModSignalStrengthNoParam") getModSignalStrength();
%rename("getRFSignalStrengthNoParam") getRFSignalStrength();
%feature("autodoc", "3");
%include "hmtrp.hpp"
%{
#include "hmtrp.hpp"

View File

@ -3,8 +3,6 @@
%module pyupm_hp20x
%include "../upm.i"
%feature("autodoc", "3");
#ifdef DOXYGEN
%include "hp20x_doc.i"
#endif

View File

@ -3,8 +3,6 @@
%module pyupm_ht9170
%include "../upm.i"
%feature("autodoc", "3");
%include "ht9170.hpp"
%{
#include "ht9170.hpp"

View File

@ -3,8 +3,6 @@
%module pyupm_htu21d
%include "../upm.i"
%feature("autodoc", "3");
#ifdef DOXYGEN
%include "htu21d_doc.i"
#endif

View File

@ -4,8 +4,6 @@
%include "../upm.i"
%include "stdint.i"
%feature("autodoc", "3");
%include "hwxpxx.hpp"
%{
#include "hwxpxx.hpp"

View File

@ -4,8 +4,6 @@
%include "../upm.i"
%include "stdint.i"
%feature("autodoc", "3");
%include "hx711.hpp"
%{
#include "hx711.hpp"

View File

@ -3,9 +3,6 @@
%module pyupm_ili9341
%include "../upm.i"
%feature("autodoc", "3");
%rename("printString") print(std::string msg);
%include "ili9341_gfx.hpp"
%{
#include "ili9341_gfx.hpp"

View File

@ -3,8 +3,6 @@
%module pyupm_ims
%include "../upm.i"
%feature("autodoc", "3");
%{
#include "ims.hpp"
%}

View File

@ -3,8 +3,6 @@
%module pyupm_ina132
%include "../upm.i"
%feature("autodoc", "3");
%include "ina132.hpp"
%{
#include "ina132.hpp"

View File

@ -4,8 +4,6 @@
// Include doxygen-generated documentation
%include "pyupm_doxy2swig.i"
%feature("autodoc", "3");
%{
#include "iLightSensor.hpp"
#include "iLightController.hpp"

View File

@ -3,8 +3,6 @@
%module pyupm_isd1820
%include "../upm.i"
%feature("autodoc", "3");
%{
#include "isd1820.hpp"
%}

View File

@ -13,8 +13,6 @@
$result = SWIG_NewPointerObj(SWIG_as_voidptr(result), SWIGTYPE_p_floatArray, 0 | 0 );
}
%feature("autodoc", "3");
#ifdef DOXYGEN
%include "itg3200_doc.i"
#endif

View File

@ -4,8 +4,6 @@
%include "../upm.i"
%include "../upm_vectortypes.i"
%feature("autodoc", "3");
%include "jhd1313m1.hpp"
%{
#include "jhd1313m1.hpp"

View File

@ -5,8 +5,6 @@
%include "stdint.i"
%feature("autodoc", "3");
%include "joystick12.hpp"
%{
#include "joystick12.hpp"

View File

@ -4,8 +4,6 @@
%include "pyupm_doxy2swig.i"
%feature("autodoc", "3");
%include "kxcjk1013.hpp"
%{
#include "kxcjk1013.hpp"

View File

@ -3,8 +3,6 @@
%module pyupm_l298
%include "../upm.i"
%feature("autodoc", "3");
%include "l298.hpp"
%{
#include "l298.hpp"

View File

@ -4,8 +4,6 @@
%include "../upm.i"
%feature("autodoc", "3");
%include "l3gd20.hpp"
%{
#include "l3gd20.hpp"

View File

@ -4,8 +4,6 @@
%include "../upm.i"
%include "../carrays_uint8_t.i"
%feature("autodoc", "3");
%include "ssd.hpp"
%include "lcd.hpp"
%{

View File

@ -4,8 +4,6 @@
%include "../upm.i"
%include "../upm_vectortypes.i"
%feature("autodoc", "3");
%include "lcdks.hpp"
%{
#include "lcdks.hpp"

Some files were not shown because too many files have changed in this diff Show More