17 Commits

Author SHA1 Message Date
Noel Eck
a5680d9b9a Doxygen: Turn off messages
Turn off non-warning/error doxygen messages to clean up the build log.

Signed-off-by: Noel Eck <noel.eck@intel.com>
2018-01-11 11:53:50 -08:00
Mihai Tudor Panu
153d8cfb12 doxy: ignore sensortemplate for documentation
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
2017-10-03 17:50:51 -07:00
Nicolas Oliver
9e09f899cf Travis CI and Documentation Generation Improvements
* Use docker images from docker hub instead of building them on Travis
* Fix doxygen warnings for Markdown Files
* Modify Travis build matrix to include stages and additional jobs
* Add doxygen2jsdoc submodule
* Add doxyport submodule
* Remove duplicated code in doxy/node directory
* Generate documentation for each language in Travis

Signed-off-by: Nicolas Oliver <dario.n.oliver@intel.com>
2017-08-14 12:46:31 -07:00
Noel Eck
8262a4203b doxygen: Use relative paths in generated docs
Updated cmake to use strip the full path to the base UPM directory
from generated documentation.  This removes the build server full-
path from UPM documentation.

Old html:

upm: /iotdk/jenkins/workspace/upm-doc-stable/src/moisture/moisture.h File Reference

New html:

upm: src/moisture/moisture.h File Reference

Signed-off-by: Noel Eck <noel.eck@intel.com>
2017-03-28 11:35:11 -07:00
Mihai Tudor Panu
eb7a3ceac7 upm-c: added doxygen tags to generate documentation for C APIs
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
2016-09-26 17:28:21 -07:00
Mihai Tudor Panu
025844fe24 doxygen: doxygen.groups changed again to groups.md due to doxygen limitations
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
2016-09-19 19:21:13 -07:00
Mihai Tudor Panu
353788a645 docs: renamed upm.hpp to a more appropriate doxygen.groups
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
2016-09-14 16:55:30 -07:00
Noel Eck
c1f9d15f67 upmc: Updates for building C modules w/base UPM
Test commit for building C UPM modules.

    * Added C include directory
    * Added C utilities directory
    * Rename C++ upm.h -> upm.hpp to make room for C upm.h
    * Added upm_mixed_module_init function to src/CMakeLists.txt.  This
      function takes filesnames similar to upm_module_init and does a
      bit of processing before calling upm_module_init.
    * Added c example directory.  Changed c++ example names.
    * Added dfrph implemention for testing (C++ wraps C).  Added mraa
      to .pc requires for dfrph.  Tested against stand-alone project.
      Added dfrph c example.
    * Update implemention of pkg-config file generation.
    * Added two cmake cache variables: BUILDCPP and BUILDFTI
    * Removed src from swig_add_module calls, added libname to
      swig_link_libraries calls.  Shrinks swig'ed binaries by ~13%.
    * Added install target in upm/CMakeLists.txt to install C header,
      directory.  Is this where we want this?
    * C FTI header directory is include/fti

Signed-off-by: Noel Eck <noel.eck@intel.com>
2016-09-14 14:07:44 -07:00
Jon Trulson
84144d0c8f bosch bme280: Remove old driver in favor of new driver to be added soon
This driver, based on bosch code is being removed in favor of a new
driver to be added soon that is more fully functional and includes SPI
support.

The new driver will be included along with a BMP280 implementation in
a new bmp280 library.

Signed-off-by: Jon Trulson <jtrulson@ics.com>
Signed-off-by: Noel Eck <noel.eck@intel.com>
2016-05-09 13:16:30 -07:00
Noel Eck
6b273a1b49 docs: Added exclude to Doxyfile for boschdriver src.
The boschdriver.h file contains tags which are picked up by
doxygen and cause incorrect results.  For example, the
\mainpage and \license cause the Bosch header collateral to
be placed on the index.html page of the UPM docs.

Added an entry to EXCLUDE_PATTERNS which handles this.

Signed-off-by: Noel Eck <noel.eck@intel.com>
2016-04-21 15:21:04 -07:00
Mihai Tudor Panu
0d20cdb25a doxygen: removed Bosch base lib from docs since only used internally
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
2016-03-24 12:57:57 -07:00
Mihai Tudor Panu
98ea1c615a docs: separated readme.md between github and c++ documentation
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
2015-09-23 15:06:54 -07:00
Mihai Tudor Panu
0f015354ef doxygen: new @altid tag for sensors supporting multiple chip variants
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
2015-06-23 10:50:26 -07:00
Mihai Tudor Panu
6dd8358d2f doxygen: fixed relative path to doxygenlayout.xml
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
2015-04-13 17:29:01 -07:00
Mihai Tudor Panu
4e89284a37 doxy: added alias for @web tab
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
2015-03-25 17:14:56 -07:00
Mihai Tudor Panu
e54d48f407 nrf8001: documentation updates and showing relation to aci lib
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
2015-03-20 14:34:23 -07:00
Mihai Tudor Panu
fd028e2f05 docs: created separate folder for doxygen config files
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
2015-03-20 11:35:37 -07:00