mirror of
https://github.com/eclipse/upm.git
synced 2025-07-03 10:21:19 +03:00
cpp_headers: Renamed C++ headers from .h -> .hpp
To make room for UPM C and C++ sensor code to coexist, all UPM C++ headers have been renamed from h -> hpp. This commit contains updates to documentation, includes, cmake collateral, examples, and swig interface files. * Renamed all cxx/cpp header files which contain the string 'copyright intel' from .h -> .hpp (if not already hpp). * Replaced all references to .h with .hpp in documentation, source files, cmake collateral, example code, and swig interface files. * Replaced cmake variable module_h with module_hpp. * Intentionally left upm.h since this file currently does not contain code (documentation only). Signed-off-by: Noel Eck <noel.eck@intel.com>
This commit is contained in:
46
src/grove/grovelight.hpp
Normal file
46
src/grove/grovelight.hpp
Normal file
@ -0,0 +1,46 @@
|
||||
/*
|
||||
* Place-holder Header for Documentation and future API change
|
||||
*
|
||||
* Copyright (c) 2014 Intel Corporation.
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining
|
||||
* a copy of this software and associated documentation files (the
|
||||
* "Software"), to deal in the Software without restriction, including
|
||||
* without limitation the rights to use, copy, modify, merge, publish,
|
||||
* distribute, sublicense, and/or sell copies of the Software, and to
|
||||
* permit persons to whom the Software is furnished to do so, subject to
|
||||
* the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be
|
||||
* included in all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
||||
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @library grove
|
||||
* @sensor grovelight
|
||||
* @comname Grove Light Sensor
|
||||
* @type light
|
||||
* @man seeed
|
||||
* @con analog
|
||||
* @kit gsk
|
||||
*
|
||||
* @brief API for the Grove Light Sensor
|
||||
*
|
||||
* The Grove light sensor detects the intensity of the ambient light.
|
||||
* As the light intensity of the environment increases, the resistance
|
||||
* of the sensor decreases. This means the raw value from the
|
||||
* analog pin is larger in bright light and smaller in the dark.
|
||||
* An approximate lux value can also be returned.
|
||||
*
|
||||
* @image html grovelight.jpg
|
||||
* @snippet grovelight.cxx Interesting
|
||||
*/
|
||||
|
Reference in New Issue
Block a user