documentation updates

Signed-off-by: Juergen Beisert <jbe@pengutronix.de>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

10 files changed, 93 insertions, 71 deletions

diff --git a/board/board.dox b/board/board.dox
index 12eff17be1..9c32682678 100644
--- a/board/board.dox
+++ b/board/board.dox
@@ -1,7 +1,7 @@
 /** @page dev_board Adapting a new Board
 
-To add a new board to barebox a few steps must be done, to extend and modify
-the barebox source tree.
+To add a new board to @a barebox a few steps must be done, to extend and modify
+the @a barebox source tree.
 
 @section board_add_files Files/Directories to be added
 
@@ -60,7 +60,7 @@ at the right architecture.
 
 @subsection board_lscript board/\<boardname\>/barebox.ld.S
 
-If your board needs a special binary barebox layout, you can provide a local
+If your board needs a special binary @a barebox layout, you can provide a local
 board linker script file. This will replace the generic one provided by your
 architecture or CPU support.
 
diff --git a/board/eukrea_cpuimx27/config.h b/board/eukrea_cpuimx27/config.h
index b3eed0bb3c..ec6f2123bf 100644
--- a/board/eukrea_cpuimx27/config.h
+++ b/board/eukrea_cpuimx27/config.h
@@ -1,7 +1,4 @@
-/**
- * @file
- * @brief Global defintions for the ARM i.MX27 based pcm038
- *
+/*
  * 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 2 of
@@ -18,6 +15,11 @@
  * MA 02111-1307 USA
  */
 
+/**
+ * @file
+ * @brief Global defintions for the ARM Eukrea cpuimx27 board
+ */
+
 #ifndef __CONFIG_H
 #define __CONFIG_H
 
diff --git a/board/freescale-mx35-3-stack/config.h b/board/freescale-mx35-3-stack/config.h
index 58f8ddbc5b..c724a57bd0 100644
--- a/board/freescale-mx35-3-stack/config.h
+++ b/board/freescale-mx35-3-stack/config.h
@@ -1,7 +1,4 @@
-/**
- * @file
- * @brief Global defintions for the ARM i.MX27 based pcm038
- *
+/*
  * 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 2 of
@@ -18,6 +15,11 @@
  * MA 02111-1307 USA
  */
 
+/**
+ * @file
+ * @brief Global defintions for the Freescale i.MX35 3-stack board
+ */
+
 #ifndef __CONFIG_H
 #define __CONFIG_H
 
diff --git a/board/imx21ads/config.h b/board/imx21ads/config.h
index 6ec1996a8b..edfb29ffb0 100644
--- a/board/imx21ads/config.h
+++ b/board/imx21ads/config.h
@@ -1,7 +1,4 @@
-/**
- * @file
- * @brief Global defintions for the ARM i.MX21 based imx21ads
- *
+/*
  * 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 2 of
@@ -17,7 +14,12 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  * MA 02111-1307 USA
  */
-	
+
+/**
+ * @file
+ * @brief Global defintions for the ARM i.MX21 based imx21ads
+ **/
+
 #ifndef __CONFIG_H
 #define __CONFIG_H
 
diff --git a/board/imx27ads/config.h b/board/imx27ads/config.h
index 169ac0c9c3..b54a3c53d4 100644
--- a/board/imx27ads/config.h
+++ b/board/imx27ads/config.h
@@ -1,7 +1,4 @@
-/**
- * @file
- * @brief Global defintions for the ARM i.MX27 based pcm038
- *
+/*
  * 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 2 of
@@ -17,7 +14,12 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  * MA 02111-1307 USA
  */
-	
+
+/**
+ * @file
+ * @brief Global defintions for the Freescale imx27ads ARM board
+ */
+
 #ifndef __CONFIG_H
 #define __CONFIG_H
 
diff --git a/board/omap/board-beagle.c b/board/omap/board-beagle.c
index 368702dd65..866d8325e5 100644
--- a/board/omap/board-beagle.c
+++ b/board/omap/board-beagle.c
@@ -1,6 +1,31 @@
+/*
+ * (C) Copyright 2008
+ * Texas Instruments, <www.ti.com>
+ * Raghavendra KH <r-khandenahally@ti.com>
+ *
+ * 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 2 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
+ */
+
 /**
  * @file
  * @brief Beagle Specific Board Initialization routines
+ */
+
+/**
+ * @page ti_beagle Texas Instruments Beagle Board
  *
  * FileName: board/omap/board-beagle.c
  *
@@ -26,26 +51,6 @@
  *
  * Originally from board/omap/board-sdp343x.c
  */
-/*
- * (C) Copyright 2008
- * Texas Instruments, <www.ti.com>
- * Raghavendra KH <r-khandenahally@ti.com>
- *
- * 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 2 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
- */
 
 #include <common.h>
 #include <console.h>
diff --git a/board/omap/board-sdp343x.c b/board/omap/board-sdp343x.c
index 1e88e397d9..fe95fc0235 100644
--- a/board/omap/board-sdp343x.c
+++ b/board/omap/board-sdp343x.c
@@ -1,6 +1,31 @@
+/*
+ * (C) Copyright 2006-2008
+ * Texas Instruments, <www.ti.com>
+ * Nishanth Menon <x0nishan@ti.com>
+ *
+ * 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 2 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
+ */
+
 /**
  * @file
  * @brief SDP3430 Specific Board Initialization routines
+ */
+
+/**
+ * @page ti_SDP3430 Texas Instruments SDP3430
  *
  * FileName: board/omap/board-sdp343x.c
  *
@@ -19,27 +44,7 @@
  * Run time initialization includes
  * @li serial @ref serial_ns16550.c driver device definition
  *
- * Originally from http://linux.omap.com/pub/bootloader/3430sdp/barebox-v1.tar.gz
- */
-/*
- * (C) Copyright 2006-2008
- * Texas Instruments, <www.ti.com>
- * Nishanth Menon <x0nishan@ti.com>
- *
- * 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 2 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
+ * Originally from http://linux.omap.com/pub/bootloader/3430sdp/u-boot-v1.tar.gz
  */
 
 #include <common.h>
diff --git a/board/pcm038/config.h b/board/pcm038/config.h
index b3eed0bb3c..c2f5e7cc58 100644
--- a/board/pcm038/config.h
+++ b/board/pcm038/config.h
@@ -1,7 +1,4 @@
-/**
- * @file
- * @brief Global defintions for the ARM i.MX27 based pcm038
- *
+/*
  * 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 2 of
@@ -18,6 +15,11 @@
  * MA 02111-1307 USA
  */
 
+/**
+ * @file
+ * @brief Global defintions for the ARM i.MX27 based pcm038
+ */
+
 #ifndef __CONFIG_H
 #define __CONFIG_H
 
diff --git a/board/phycard-i.MX27/config.h b/board/phycard-i.MX27/config.h
index b3eed0bb3c..c2f5e7cc58 100644
--- a/board/phycard-i.MX27/config.h
+++ b/board/phycard-i.MX27/config.h
@@ -1,7 +1,4 @@
-/**
- * @file
- * @brief Global defintions for the ARM i.MX27 based pcm038
- *
+/*
  * 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 2 of
@@ -18,6 +15,11 @@
  * MA 02111-1307 USA
  */
 
+/**
+ * @file
+ * @brief Global defintions for the ARM i.MX27 based pcm038
+ */
+
 #ifndef __CONFIG_H
 #define __CONFIG_H
 
diff --git a/board/phycore_mcf54xx/phyCore_MCF54xx.c b/board/phycore_mcf54xx/phyCore_MCF54xx.c
index b6eb311dd7..3bc2d12a42 100644
--- a/board/phycore_mcf54xx/phyCore_MCF54xx.c
+++ b/board/phycore_mcf54xx/phyCore_MCF54xx.c
@@ -15,7 +15,7 @@
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
- * along with barebox.  If not, see <http://www.gnu.org/licenses/>.
+ * along with barebox. If not, see <http://www.gnu.org/licenses/>.
  */
 
 /** @file