14 Commits

Author SHA1 Message Date
Mihai Tudor Panu
cffaf5c6ba documentation.md: finalized content for writing sensor documentation
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
2017-10-03 17:41:24 -07:00
Mihai Tudor Panu
ab841ef591 documentation.md: updated to explain the new JSON format for sensors
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
2017-10-03 16:11:23 -07:00
Noel Eck
283fce619e doc: Scrubbed ALL sensor library descriptions
In an effort to clean-up and standardize UPM library
documentation, this commit updates (and in most cases,
unifies) the CMake description string AND CXX header
@comname string.

Strings were taken from datasheets when possible, spelling
mistakes were addressed, copy/paste errors where fixed,
Title Case was used, etc.

    * Tested/updated/added @web tags
    * Added/updated invalid sensor images
    * Added/updated @man tags, added missing manufacturers

Signed-off-by: Noel Eck <noel.eck@intel.com>
2017-02-08 11:50:00 -08: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
Mihai Tudor Panu
9d1afd35f8 docs: minor adjustments to doxygen tag instructions
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
2016-02-01 15:36:37 -08: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
John Van Drasek
ff55f641a2 documentation.md: Add details of what code files to put sensor block comments
Signed-off-by: John Van Drasek <john.r.van.drasek@intel.com>
2015-03-20 14:30:46 -07:00
Mihai Tudor Panu
1792eb9cfe docs: added optional @web tag for sensor links
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
2015-03-20 11:35:27 -07:00
Mihai Tudor Panu
10d1975bc2 docs: prevented doxygen tag name clash and added aliases
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
2015-03-10 17:11:24 -07:00
Mihai Tudor Panu
f0dd5f9530 docs: updated documentation.md with more details
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
2015-03-06 17:53:11 -08:00
Mihai Tudor Panu
b4c265005f docs: few touch ups and typos fixed
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
2015-03-04 11:26:23 -08:00
Mihai Tudor Panu
9dcef6d7bb docs: created new documentation.md
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
2015-03-02 11:59:03 -08:00