mbed library sources
Fork of mbed-src by
Diff: cpp/DigitalIn.h
- Revision:
- 2:143cac498751
- Parent:
- 0:fd0d7bdfcdc2
--- a/cpp/DigitalIn.h Thu Nov 29 15:41:14 2012 +0000 +++ b/cpp/DigitalIn.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_DIGITALIN_H #define MBED_DIGITALIN_H @@ -33,12 +27,12 @@ * Example: * @code * // Flash an LED while a DigitalIn is true - * + * * #include "mbed.h" - * + * * DigitalIn enable(p5); * DigitalOut led(LED1); - * + * * int main() { * while(1) { * if(enable) { @@ -60,17 +54,17 @@ DigitalIn(PinName pin) { gpio_init(&gpio, pin, PIN_INPUT); } - + /** Read the input, represented as 0 or 1 (int) * * @returns - * An integer representing the state of the input pin, + * An integer representing the state of the input pin, * 0 for logical 0, 1 for logical 1 */ int read() { return gpio_read(&gpio); } - + /** Set the input pin mode * * @param mode PullUp, PullDown, PullNone, OpenDrain @@ -78,7 +72,7 @@ void mode(PinMode pull) { gpio_mode(&gpio, pull); } - + #ifdef MBED_OPERATORS /** An operator shorthand for read() */