mbed library sources
Fork of mbed-src by
Diff: cpp/AnalogIn.h
- Revision:
- 2:143cac498751
- Parent:
- 0:fd0d7bdfcdc2
diff -r 62685faffa05 -r 143cac498751 cpp/AnalogIn.h --- a/cpp/AnalogIn.h Thu Nov 29 15:41:14 2012 +0000 +++ b/cpp/AnalogIn.h Mon Feb 18 11:44:18 2013 +0000 @@ -1,23 +1,17 @@ /* mbed Microcontroller Library - * Copyright (c) 2006-2012 ARM Limited + * Copyright (c) 2006-2013 ARM Limited * - * 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: + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at * - * The above copyright notice and this permission notice shall be included in - * all copies or substantial portions of the Software. + * http://www.apache.org/licenses/LICENSE-2.0 * - * 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. + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ #ifndef MBED_ANALOGIN_H #define MBED_ANALOGIN_H @@ -35,11 +29,11 @@ * Example: * @code * // Print messages when the AnalogIn is greater than 50% - * + * * #include "mbed.h" - * + * * AnalogIn temperature(p20); - * + * * int main() { * while(1) { * if(temperature > 0.5) { @@ -55,13 +49,13 @@ /** Create an AnalogIn, connected to the specified pin * - * @param pin AnalogIn pin to connect to + * @param pin AnalogIn pin to connect to * @param name (optional) A string to identify the object */ AnalogIn(PinName pin) { analogin_init(&_adc, pin); } - + /** Read the input voltage, represented as a float in the range [0.0, 1.0] * * @returns A floating-point value representing the current input voltage, measured as a percentage @@ -73,7 +67,7 @@ /** Read the input voltage, represented as an unsigned short in the range [0x0, 0xFFFF] * * @returns - * 16-bit unsigned short representing the current input voltage, normalised to a 16-bit value + * 16-bit unsigned short representing the current input voltage, normalised to a 16-bit value */ unsigned short read_u16() { return analogin_read_u16(&_adc); @@ -88,7 +82,7 @@ * @code * float x = volume.read(); * float x = volume; - * + * * if(volume.read() > 0.25) { ... } * if(volume > 0.25) { ... } * @endcode