From c347af177b19b41d677c7a2aa79f63d9072e6278 Mon Sep 17 00:00:00 2001
From: dankers <dankers>
Date: Sat, 28 Nov 2009 11:25:16 +0000
Subject: [PATCH] Finish adding doxygen comments to files

git-svn-id: svn://svn.openpilot.org/OpenPilot/trunk@5 ebee16cc-31ac-478f-84a7-5cbb03baadba
---
 flight/sys/link_stm32f10x_HD.ld | 31 +++++++++++++++++++++++++++----
 flight/sys/pios.c               |  3 ++-
 flight/sys/pios.h               |  6 ++++++
 flight/sys/pios_board.h         |  5 ++++-
 flight/sys/pios_led.c           |  3 +++
 flight/sys/pios_led.h           |  5 ++++-
 flight/sys/pios_settings.c      |  5 ++++-
 flight/sys/pios_settings.h      |  5 ++++-
 flight/sys/pios_sys.c           |  3 +++
 flight/sys/pios_sys.h           |  3 +++
 flight/sys/pios_uart.c          |  3 +++
 flight/sys/pios_uart.h          |  5 ++++-
 12 files changed, 67 insertions(+), 10 deletions(-)

diff --git a/flight/sys/link_stm32f10x_HD.ld b/flight/sys/link_stm32f10x_HD.ld
index 67f830b7b..57efa107a 100644
--- a/flight/sys/link_stm32f10x_HD.ld
+++ b/flight/sys/link_stm32f10x_HD.ld
@@ -1,7 +1,30 @@
-/*
-Linker script for STM32F103RE
-Based on scripts from Raisonance
-*/
+
+/**
+ * Project: OpenPilot
+ *    
+ * @author The OpenPilot Team, http://www.openpilot.org, Copyright (C) 2009.
+ *    
+ * @file link_stm32f10x_HD.ld
+ * PiOS linker for the OpenPilot board
+ *
+ * @see The GNU Public License (GPL)
+ */
+/* 
+ * This program is free software; you can redistribute it and/or modify 
+ * it under the terms of the GNU General Public License as published by 
+ * the Free Software Foundation; either version 3 of the License, or 
+ * (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
+ * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 
+ * for more details.
+ * 
+ * You should have received a copy of the GNU General Public License along 
+ * with this program; if not, write to the Free Software Foundation, Inc., 
+ * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ */
+
 
 /* Memory Spaces Definitions */
 MEMORY
diff --git a/flight/sys/pios.c b/flight/sys/pios.c
index 849c2483c..4ccf51087 100644
--- a/flight/sys/pios.c
+++ b/flight/sys/pios.c
@@ -5,7 +5,8 @@
  * @author The OpenPilot Team, http://www.openpilot.org, Copyright (C) 2009.
  *    
  * @file pios.c
- * PiOS build, sets up main tasks, tickhook and calls hardware setup
+ * PiOS build, sets up main tasks, tickhook, and contains the Main function
+ * It all starts from here
  *
  * @see The GNU Public License (GPL)
  */
diff --git a/flight/sys/pios.h b/flight/sys/pios.h
index 16c91941c..ad190160f 100644
--- a/flight/sys/pios.h
+++ b/flight/sys/pios.h
@@ -4,6 +4,12 @@
  *    
  * @author The OpenPilot Team, http://www.openpilot.org, Copyright (C) 2009.
  *    
+ * @file pios.h
+ * PiOS header. Central header for the project
+ *
+ * @see The GNU Public License (GPL) 
+
+*    
  * @see The GNU Public License (GPL)
  */
 /* 
diff --git a/flight/sys/pios_board.h b/flight/sys/pios_board.h
index 3edf3c02d..3d6ce71fe 100644
--- a/flight/sys/pios_board.h
+++ b/flight/sys/pios_board.h
@@ -3,7 +3,10 @@
  * Project: OpenPilot
  *    
  * @author The OpenPilot Team, http://www.openpilot.org, Copyright (C) 2009.
- *    
+ *
+ * @file pios_board.h
+ * Defines board hardware for the OpenPilot hardware
+ *   
  * @see The GNU Public License (GPL)
  */
 /* 
diff --git a/flight/sys/pios_led.c b/flight/sys/pios_led.c
index 27237a73e..64464fb28 100644
--- a/flight/sys/pios_led.c
+++ b/flight/sys/pios_led.c
@@ -3,6 +3,9 @@
  * Project: OpenPilot
  *    
  * @author The OpenPilot Team, http://www.openpilot.org, Copyright (C) 2009.
+ *
+ * @file pios_led.c
+ * LED functions, init, toggle, on & off 
  *    
  * @see The GNU Public License (GPL)
  */
diff --git a/flight/sys/pios_led.h b/flight/sys/pios_led.h
index 157af7958..020fae166 100644
--- a/flight/sys/pios_led.h
+++ b/flight/sys/pios_led.h
@@ -3,7 +3,10 @@
  * Project: OpenPilot
  *    
  * @author The OpenPilot Team, http://www.openpilot.org, Copyright (C) 2009.
- *    
+ *  
+ * @file pios_led.h
+ * LED functions header  
+ *
  * @see The GNU Public License (GPL)
  */
 /* 
diff --git a/flight/sys/pios_settings.c b/flight/sys/pios_settings.c
index ab90900d6..5b9e29a9b 100644
--- a/flight/sys/pios_settings.c
+++ b/flight/sys/pios_settings.c
@@ -3,7 +3,10 @@
  * Project: OpenPilot
  *    
  * @author The OpenPilot Team, http://www.openpilot.org, Copyright (C) 2009.
- *    
+ * 
+ * @file pios_settings.c
+ * Gets and sets settings, normally from SDCard  
+ *
  * @see The GNU Public License (GPL)
  */
 /* 
diff --git a/flight/sys/pios_settings.h b/flight/sys/pios_settings.h
index 79ae21add..90c489cf2 100644
--- a/flight/sys/pios_settings.h
+++ b/flight/sys/pios_settings.h
@@ -3,7 +3,10 @@
  * Project: OpenPilot
  *    
  * @author The OpenPilot Team, http://www.openpilot.org, Copyright (C) 2009.
- *    
+ * 
+ * @file pios_settings.h
+ * Settings functions header 
+ *   
  * @see The GNU Public License (GPL)
  */
 /* 
diff --git a/flight/sys/pios_sys.c b/flight/sys/pios_sys.c
index ebb3e38da..56c3790f1 100644
--- a/flight/sys/pios_sys.c
+++ b/flight/sys/pios_sys.c
@@ -4,6 +4,9 @@
  *    
  * @author The OpenPilot Team, http://www.openpilot.org, Copyright (C) 2009.
  *    
+ * @file pios_sys.c
+ * Sets up basic system hardware, functions are called from the Main function
+ *
  * @see The GNU Public License (GPL)
  */
 /* 
diff --git a/flight/sys/pios_sys.h b/flight/sys/pios_sys.h
index d35f6b8fb..0dc7d98fa 100644
--- a/flight/sys/pios_sys.h
+++ b/flight/sys/pios_sys.h
@@ -4,6 +4,9 @@
  *    
  * @author The OpenPilot Team, http://www.openpilot.org, Copyright (C) 2009.
  *    
+ * @file pios_sys.h
+ * System and hardware Init functions header 
+ *
  * @see The GNU Public License (GPL)
  */
 /* 
diff --git a/flight/sys/pios_uart.c b/flight/sys/pios_uart.c
index be6f3eb02..902f95cfb 100644
--- a/flight/sys/pios_uart.c
+++ b/flight/sys/pios_uart.c
@@ -3,6 +3,9 @@
  *    
  * @author The OpenPilot Team, http://www.openpilot.org, Copyright (C) 2009.
  *    
+ * @file pios_uart.c
+ * UART commands, Inits UARTS, controls & talks to UARTS
+ *
  * @see The GNU Public License (GPL)
  */
 /* 
diff --git a/flight/sys/pios_uart.h b/flight/sys/pios_uart.h
index 7f88c9ecd..3975a0d5b 100644
--- a/flight/sys/pios_uart.h
+++ b/flight/sys/pios_uart.h
@@ -3,7 +3,10 @@
  * Project: OpenPilot
  *    
  * @author The OpenPilot Team, http://www.openpilot.org, Copyright (C) 2009.
- *    
+ *  
+ * @file pios_uart.h
+ * UART functions header 
+ *  
  * @see The GNU Public License (GPL)
  */
 /*