diff options
author | Lorenz Meier <lm@inf.ethz.ch> | 2012-08-05 11:27:02 +0200 |
---|---|---|
committer | Lorenz Meier <lm@inf.ethz.ch> | 2012-08-05 11:27:02 +0200 |
commit | b5f7adfc1034f8a32d1528b462333d44f3a0a6b8 (patch) | |
tree | 7a8745fa6040e13811c1ae433a99861ee210df26 | |
parent | 4f4a3a48bfc5908412ad3bfdf75742f1f73f74b2 (diff) | |
download | px4-firmware-b5f7adfc1034f8a32d1528b462333d44f3a0a6b8.tar.gz px4-firmware-b5f7adfc1034f8a32d1528b462333d44f3a0a6b8.tar.bz2 px4-firmware-b5f7adfc1034f8a32d1528b462333d44f3a0a6b8.zip |
Many Doxygen style fixes
-rw-r--r-- | apps/fixedwing_control/fixedwing_control.c | 2 | ||||
-rw-r--r-- | apps/px4/tests/test_sensors.c | 15 | ||||
-rw-r--r-- | apps/px4/tests/tests_main.c | 13 | ||||
-rw-r--r-- | apps/systemcmds/boardinfo/boardinfo.c | 8 | ||||
-rw-r--r-- | apps/systemcmds/reboot/reboot.c | 32 | ||||
-rw-r--r-- | apps/systemcmds/top/top.c | 35 | ||||
-rw-r--r-- | apps/systemlib/hx_stream.c | 6 | ||||
-rw-r--r-- | apps/systemlib/hx_stream.h | 6 | ||||
-rw-r--r-- | apps/systemlib/mixer.c | 37 | ||||
-rw-r--r-- | apps/systemlib/mixer.h | 37 | ||||
-rw-r--r-- | apps/systemlib/perf_counter.h | 3 | ||||
-rw-r--r-- | apps/systemlib/systemlib.c | 7 | ||||
-rw-r--r-- | apps/systemlib/systemlib.h | 6 | ||||
-rw-r--r-- | apps/systemlib/visibility.h | 4 |
14 files changed, 134 insertions, 77 deletions
diff --git a/apps/fixedwing_control/fixedwing_control.c b/apps/fixedwing_control/fixedwing_control.c index 2745ef6db..cc834e957 100644 --- a/apps/fixedwing_control/fixedwing_control.c +++ b/apps/fixedwing_control/fixedwing_control.c @@ -32,7 +32,7 @@ * ****************************************************************************/ -/* +/** * @file fixedwing_control.c * Implementation of a fixed wing attitude and position controller. */ diff --git a/apps/px4/tests/test_sensors.c b/apps/px4/tests/test_sensors.c index bdb68f88b..1a7ebcc7a 100644 --- a/apps/px4/tests/test_sensors.c +++ b/apps/px4/tests/test_sensors.c @@ -1,7 +1,7 @@ /**************************************************************************** - * px4/sensors/test_sensors.c * - * Copyright (C) 2012 PX4 Development Team. All rights reserved. + * Copyright (C) 2012 PX4 Development Team. All rights reserved. + * Author: @author Lorenz Meier <lm@inf.ethz.ch> * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions @@ -13,7 +13,7 @@ * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. - * 3. Neither the name NuttX nor the names of its contributors may be + * 3. Neither the name PX4 nor the names of its contributors may be * used to endorse or promote products derived from this software * without specific prior written permission. * @@ -32,9 +32,12 @@ * ****************************************************************************/ -/**************************************************************************** - * Included Files - ****************************************************************************/ +/** + * @file test_sensors.c + * Tests the onboard sensors. + * + * The sensors app must not be running when performing this test. + */ #include <nuttx/config.h> diff --git a/apps/px4/tests/tests_main.c b/apps/px4/tests/tests_main.c index 704b5a237..63af9098d 100644 --- a/apps/px4/tests/tests_main.c +++ b/apps/px4/tests/tests_main.c @@ -1,7 +1,7 @@ /**************************************************************************** - * px4/sensors/tests_main.c * - * Copyright (C) 2012 PX4 Development Team. All rights reserved. + * Copyright (C) 2012 PX4 Development Team. All rights reserved. + * Author: @author Lorenz Meier <lm@inf.ethz.ch> * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions @@ -13,7 +13,7 @@ * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. - * 3. Neither the name NuttX nor the names of its contributors may be + * 3. Neither the name PX4 nor the names of its contributors may be * used to endorse or promote products derived from this software * without specific prior written permission. * @@ -32,9 +32,10 @@ * ****************************************************************************/ -/**************************************************************************** - * Included Files - ****************************************************************************/ +/** + * @file tests_main.c + * Tests main file, loads individual tests. + */ #include <nuttx/config.h> diff --git a/apps/systemcmds/boardinfo/boardinfo.c b/apps/systemcmds/boardinfo/boardinfo.c index 61a6ea221..0ae0ee8d2 100644 --- a/apps/systemcmds/boardinfo/boardinfo.c +++ b/apps/systemcmds/boardinfo/boardinfo.c @@ -3,7 +3,6 @@ * Copyright (C) 2012 PX4 Development Team. All rights reserved. * Author: Lorenz Meier <lm@inf.ethz.ch> * - * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: @@ -33,7 +32,10 @@ * ****************************************************************************/ -/* @file autopilot and carrier board information app */ +/** + * @file boardinfo.c + * autopilot and carrier board information app + */ #include <nuttx/config.h> @@ -46,7 +48,7 @@ __EXPORT int boardinfo_main(int argc, char *argv[]); -/* +/** * Reads out the board information * * @param argc the number of string arguments (including the executable name) diff --git a/apps/systemcmds/reboot/reboot.c b/apps/systemcmds/reboot/reboot.c index 2a4cb18d0..e8886139d 100644 --- a/apps/systemcmds/reboot/reboot.c +++ b/apps/systemcmds/reboot/reboot.c @@ -1,8 +1,7 @@ /**************************************************************************** - * apps/reboot.c * - * Copyright (C) 2012 Lorenz Meier. All rights reserved. - * Author: Lorenz Meier <lm@inf.ethz.ch> + * Copyright (C) 2012 PX4 Development Team. All rights reserved. + * Author: @author Lorenz Meier <lm@inf.ethz.ch> * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions @@ -14,7 +13,7 @@ * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. - * 3. Neither the name NuttX nor the names of its contributors may be + * 3. Neither the name PX4 nor the names of its contributors may be * used to endorse or promote products derived from this software * without specific prior written permission. * @@ -33,10 +32,10 @@ * ****************************************************************************/ -/**************************************************************************** - * Included Files - ****************************************************************************/ - +/** + * @file reboot.c + * Tool similar to UNIX reboot command + */ #include <nuttx/config.h> #include <unistd.h> @@ -44,25 +43,8 @@ #include "systemlib/systemlib.h" - -/**************************************************************************** - * Definitions - ****************************************************************************/ - -/**************************************************************************** - * Private Data - ****************************************************************************/ - -/**************************************************************************** - * Public Functions - ****************************************************************************/ - __EXPORT int reboot_main(int argc, char *argv[]); -/**************************************************************************** - * user_start - ****************************************************************************/ - int reboot_main(int argc, char *argv[]) { reboot(); diff --git a/apps/systemcmds/top/top.c b/apps/systemcmds/top/top.c index af1bb23d9..cbbeb8cc0 100644 --- a/apps/systemcmds/top/top.c +++ b/apps/systemcmds/top/top.c @@ -1,8 +1,7 @@ /**************************************************************************** - * apps/reboot.c * - * Copyright (C) 2012 Lorenz Meier. All rights reserved. - * Author: Lorenz Meier <lm@inf.ethz.ch> + * Copyright (C) 2012 PX4 Development Team. All rights reserved. + * Author: @author Lorenz Meier <lm@inf.ethz.ch> * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions @@ -14,7 +13,7 @@ * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. - * 3. Neither the name NuttX nor the names of its contributors may be + * 3. Neither the name PX4 nor the names of its contributors may be * used to endorse or promote products derived from this software * without specific prior written permission. * @@ -33,10 +32,11 @@ * ****************************************************************************/ -/**************************************************************************** - * Included Files - ****************************************************************************/ - +/** + * @file top.c + * Tool similar to UNIX top command + * @see http://en.wikipedia.org/wiki/Top_unix + */ #include <nuttx/config.h> #include <stdio.h> @@ -49,24 +49,11 @@ #include <arch/board/up_cpuload.h> #include <arch/board/up_hrt.h> -/**************************************************************************** - * Definitions - ****************************************************************************/ - -/**************************************************************************** - * Private Data - ****************************************************************************/ - -/**************************************************************************** - * Public Functions - ****************************************************************************/ - +/** + * Start the top application. + */ __EXPORT int top_main(int argc, char *argv[]); -/**************************************************************************** - * user_start - ****************************************************************************/ - extern struct system_load_s system_load; bool top_sigusr1_rcvd = false; diff --git a/apps/systemlib/hx_stream.c b/apps/systemlib/hx_stream.c index e7e974998..7ee9888ea 100644 --- a/apps/systemlib/hx_stream.c +++ b/apps/systemlib/hx_stream.c @@ -32,8 +32,10 @@ ****************************************************************************/ /** - * @file A simple serial line framing protocol based on HDLC - * with 32-bit CRC protection. + * @file hx_stream.c + * + * A simple serial line framing protocol based on HDLC + * with 32-bit CRC protection. */ #include <stdint.h> diff --git a/apps/systemlib/hx_stream.h b/apps/systemlib/hx_stream.h index 591bb1291..e33cfcd84 100644 --- a/apps/systemlib/hx_stream.h +++ b/apps/systemlib/hx_stream.h @@ -32,8 +32,10 @@ ****************************************************************************/ /** - * @file A simple serial line framing protocol based on HDLC - * with 32-bit CRC protection. + * @file hx_stream.h + * + * A simple serial line framing protocol based on HDLC + * with 32-bit CRC protection. */ #ifndef _SYSTEMLIB_HX_STREAM_H diff --git a/apps/systemlib/mixer.c b/apps/systemlib/mixer.c index f372d04bc..553680fed 100644 --- a/apps/systemlib/mixer.c +++ b/apps/systemlib/mixer.c @@ -1,5 +1,40 @@ +/**************************************************************************** + * + * Copyright (C) 2012 PX4 Development Team. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * 3. Neither the name PX4 nor the names of its contributors may be + * used to endorse or promote products derived from this software + * without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS + * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE + * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, + * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS + * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED + * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN + * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + * + ****************************************************************************/ + /** - * @file Generic control value mixing library. + * @file mixer.c + * + * Generic control value mixing library. * * This library implements a generic mixer function that can be used * by any driver or subsytem that wants to combine several control signals diff --git a/apps/systemlib/mixer.h b/apps/systemlib/mixer.h index fe95204a6..f95d03f31 100644 --- a/apps/systemlib/mixer.h +++ b/apps/systemlib/mixer.h @@ -1,5 +1,40 @@ +/**************************************************************************** + * + * Copyright (C) 2012 PX4 Development Team. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * 3. Neither the name PX4 nor the names of its contributors may be + * used to endorse or promote products derived from this software + * without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS + * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE + * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, + * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS + * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED + * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN + * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + * + ****************************************************************************/ + /** - * @file Generic control value mixing library. + * @file mixer.h + * + * Generic control value mixing library. * * This library implements a generic mixer function that can be used * by any driver or subsytem that wants to combine several control signals diff --git a/apps/systemlib/perf_counter.h b/apps/systemlib/perf_counter.h index 2ea6591c5..5dc441056 100644 --- a/apps/systemlib/perf_counter.h +++ b/apps/systemlib/perf_counter.h @@ -32,7 +32,8 @@ ****************************************************************************/ /** - * @file Performance measuring tools. + * @file perf_counter.h + * Performance measuring tools. */ #ifndef _SYSTEMLIB_PERF_COUNTER_H diff --git a/apps/systemlib/systemlib.c b/apps/systemlib/systemlib.c index 6bde8b8ae..609cf5d34 100644 --- a/apps/systemlib/systemlib.c +++ b/apps/systemlib/systemlib.c @@ -1,7 +1,7 @@ /**************************************************************************** * * Copyright (C) 2012 PX4 Development Team. All rights reserved. - * Author: Lorenz Meier <lm@inf.ethz.ch> + * Author: @author Lorenz Meier <lm@inf.ethz.ch> * * * Redistribution and use in source and binary forms, with or without @@ -33,7 +33,10 @@ * ****************************************************************************/ -/** @file implementation of commonly used low-level system-call like functions */ +/** + * @file systemlib.c + * Implementation of commonly used low-level system-call like functions + */ #include <nuttx/config.h> #include <unistd.h> diff --git a/apps/systemlib/systemlib.h b/apps/systemlib/systemlib.h index e75f6ec9c..eec43a5b4 100644 --- a/apps/systemlib/systemlib.h +++ b/apps/systemlib/systemlib.h @@ -3,7 +3,6 @@ * Copyright (C) 2012 PX4 Development Team. All rights reserved. * Author: Lorenz Meier <lm@inf.ethz.ch> * - * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: @@ -33,7 +32,10 @@ * ****************************************************************************/ -/** @file definition of commonly used low-level system-call like functions */ +/** + * @file systemlib.h + * Definition of commonly used low-level system-call like functions + */ #ifndef SYSTEMLIB_H_ #define SYSTEMLIB_H_ diff --git a/apps/systemlib/visibility.h b/apps/systemlib/visibility.h index 9bd20e2a8..64e83bbad 100644 --- a/apps/systemlib/visibility.h +++ b/apps/systemlib/visibility.h @@ -32,7 +32,9 @@ ****************************************************************************/ /** - * @file Definitions controlling symbol naming and visibility. + * @file visibility.h + * + * Definitions controlling symbol naming and visibility. * * This file is normally included automatically by the build system. */ |