16 Commits

Author SHA1 Message Date
Manivannan Sadhasivam
e562c774cf examples: cleanup examples directory
Following changes are done as a part of cleanup:

1. Moved the platform specific `C` examples from top level examples/
directory to platform/ subdirectory and renamed helloedison.c to
gpio_edison.c

2. C specific examples are moved to a new c/ subdirectory. As a part
of this process, examples are modified to follow same standards
and few new examples are also added.

3. Include the newly added C examples to relevant API documentation

4. Ran clang-format for all source files in c/, c++/, platform/
subdirectories

Signed-off-by: Manivannan Sadhasivam <manivannan.sadhasivam@linaro.org>
Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
2018-01-18 14:12:08 +01:00
Nicolas Oliver
e0a1862ce3 Travis CI and Documentation Generation improvements
* Use docker images from docker hub instead of building them on Travis
* Fix doxygen warnings for C/C++ Documentation
* Fix examples inclusion in documentation
* Modify Travis build matrix to include stages and additional jobs
* Update doxygen2jsdoc submodule
* Add doxyport submodule
* Generate documentation for each language in Travis
* Add sonar.java.binaries to sonar-scan.sh

Signed-off-by: Nicolas Oliver <dario.n.oliver@intel.com>
2017-08-10 10:47:11 -03:00
Noel Eck
b937c521f6 Doxyfile.in: Use relative paths in generated docs
Updated Doxyfile to strip the full path to the base MRAA directory
from generated documentation.  This removes the build path from
MRAA documentation.

Old html:

aio_8h.html:<title>mraa: /iotdk/jenkins/workspace/upm-doc-stable/api/mraa/aio.h File Reference</title>

New html:

aio_8h.html:<title>mraa: api/mraa/aio.h File Reference</title>

Signed-off-by: Noel Eck <noel.eck@intel.com>
Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
2017-04-02 20:02:43 +02:00
Brendan Le Foll
67f5ab7346 CONTRIBUTING.md: Add github style contributing rules
Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
2016-02-02 17:22:49 +00:00
Brendan Le Foll
44f55cfdc8 mraa: update description of libmraa
Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
2014-06-30 11:49:06 +01:00
Thomas Ingleby
6853997a92 mraa: rename from maa to mraa
Signed-off-by: Thomas Ingleby <thomas.c.ingleby@intel.com>
2014-06-24 17:24:54 +01:00
Brendan Le Foll
fdfafa5626 README.md: make more github friendly readme and move to docs/
Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
2014-06-11 14:16:47 +01:00
Brendan Le Foll
faedfce419 maa: add global maa.h and maa.hpp and stop using /usr/include/maa/
* pkg-config now only sees maa.h & maa.hpp
* usage of maa/*.{h,hpp} is still allowed
* examples updated to use maa.{h,hpp}

Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
2014-06-10 16:47:37 +01:00
Brendan Le Foll
fac705768d Doxyfile.in: remove deprecated options in doxygen 1.8
Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
2014-05-30 17:09:54 +01:00
Brendan Le Foll
a5539118c8 Doxyfile.in: remove include dir from INPUT path
Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
2014-05-30 09:52:05 +01:00
Brendan Le Foll
a02923beec docs: Add docs/ folder with in depth topics as well as DoxygenLayout.xml file
* C headers now have @briefs and include examples
* Examples have altered 'Interesting' Sections

Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
2014-05-29 14:51:38 +01:00
Brendan Le Foll
d6852c63a7 doxygen: add examples from examples dir and include one section on Readme.md
Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
2014-05-23 14:47:34 +01:00
Brendan Le Foll
dc68f40a26 pydoc: add full generation of pydoc for pymaa
Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
2014-04-29 16:33:59 +01:00
Brendan Le Foll
77ee9ffff5 doc: initial documentation of api
Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
2014-04-28 18:39:07 +01:00
Brendan Le Foll
bcfa9669d2 Doxyfile.in: use lib version number in doxyfile
Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
2014-04-28 13:57:34 +01:00
Brendan Le Foll
a28d538321 Doxyfile.in: add basic doxyfile for make doc
Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
2014-04-27 21:48:22 +01:00