aboutsummaryrefslogtreecommitdiff
path: root/apps/systemcmds
diff options
context:
space:
mode:
authorLorenz Meier <lm@inf.ethz.ch>2012-08-05 11:27:02 +0200
committerLorenz Meier <lm@inf.ethz.ch>2012-08-05 11:27:02 +0200
commitb5f7adfc1034f8a32d1528b462333d44f3a0a6b8 (patch)
tree7a8745fa6040e13811c1ae433a99861ee210df26 /apps/systemcmds
parent4f4a3a48bfc5908412ad3bfdf75742f1f73f74b2 (diff)
downloadpx4-firmware-b5f7adfc1034f8a32d1528b462333d44f3a0a6b8.tar.gz
px4-firmware-b5f7adfc1034f8a32d1528b462333d44f3a0a6b8.tar.bz2
px4-firmware-b5f7adfc1034f8a32d1528b462333d44f3a0a6b8.zip
Many Doxygen style fixes
Diffstat (limited to 'apps/systemcmds')
-rw-r--r--apps/systemcmds/boardinfo/boardinfo.c8
-rw-r--r--apps/systemcmds/reboot/reboot.c32
-rw-r--r--apps/systemcmds/top/top.c35
3 files changed, 23 insertions, 52 deletions
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;