From f522d42597ad0db4abb09c4376f8ad4acc10963b Mon Sep 17 00:00:00 2001 From: Juergen Beisert Date: Mon, 14 Dec 2009 09:28:51 +0100 Subject: [PATCH] Some doxygen related fixes Nishanth Menon wrote: > no signed off by and no diffstat? Ups. > can you use git-format-patch to send please? it is easier to review. Sure. Here it comes: jbe ------8<---------8<---------8<---------8<---------8<---------8<---- Subject: [PATCH] Some doxygen related fixes: - fix a few doxygen comments that are used in a wrong way - move some pages and their content to a better place in the generated documentation Signed-off-by: Juergen Beisert Signed-off-by: Sascha Hauer --- Documentation/developers_manual.dox | 1 + arch/architecture.dox | 1 + arch/arm/cpu/cpu.c | 6 ------ arch/arm/cpu/interrupts.c | 6 ------ arch/arm/mach-omap/syslib.c | 2 +- arch/m68k/lib/m68k-linuxboot.c | 3 ++- board/kp_ukd_r1_num/highlevel_init.c | 5 +++-- board/kp_ukd_r1_num/lowlevel_init.c | 3 ++- board/kp_ukd_r1_num/pci-stubs.c | 3 ++- board/phycore_mcf54xx/highlevel_init.c | 5 +++-- board/phycore_mcf54xx/lowlevel_init.c | 3 ++- board/phycore_mcf54xx/pci-stubs.c | 3 ++- board/phycore_mcf54xx/phyCore_MCF54xx.c | 3 ++- commands/bootm.c | 1 + 14 files changed, 22 insertions(+), 23 deletions(-) diff --git a/Documentation/developers_manual.dox b/Documentation/developers_manual.dox index 80f07f2eb..ab941e23b 100644 --- a/Documentation/developers_manual.dox +++ b/Documentation/developers_manual.dox @@ -19,5 +19,6 @@ This part of the documentation is intended for developers of U-Boot-v2. @li @subpage boot_preparation @li @subpage uboot_simul @li @subpage io_access_functions +@li @subpage mcfv4e_MCDlib */ diff --git a/arch/architecture.dox b/arch/architecture.dox index 6ef5ba928..238385275 100644 --- a/arch/architecture.dox +++ b/arch/architecture.dox @@ -87,6 +87,7 @@ TODO @li @subpage dev_arm_mach @li @subpage dev_bf_mach @li @subpage dev_ppc_mach +@li @subpage dev_m68k_mach */ diff --git a/arch/arm/cpu/cpu.c b/arch/arm/cpu/cpu.c index 180f4583b..154f8cc46 100644 --- a/arch/arm/cpu/cpu.c +++ b/arch/arm/cpu/cpu.c @@ -162,12 +162,6 @@ int cleanup_before_linux (void) * required. */ -/** - * @page arm_for_linux Preparing for Linux to run - * - * What's to do on ARM to run Linux after U-Boot did its job? - */ - static int do_icache(cmd_tbl_t *cmdtp, int argc, char *argv[]) { if (argc == 1) { diff --git a/arch/arm/cpu/interrupts.c b/arch/arm/cpu/interrupts.c index 418da18b4..0557172fe 100644 --- a/arch/arm/cpu/interrupts.c +++ b/arch/arm/cpu/interrupts.c @@ -198,9 +198,3 @@ void do_irq (struct pt_regs *pt_regs) show_regs (pt_regs); bad_mode (); } - -/** - * @page arm_interrupts Interrupt handling on ARM - * - * Why U-boot doesn't use interrupts? - */ diff --git a/arch/arm/mach-omap/syslib.c b/arch/arm/mach-omap/syslib.c index 4f70abcd5..2b25dc153 100644 --- a/arch/arm/mach-omap/syslib.c +++ b/arch/arm/mach-omap/syslib.c @@ -40,7 +40,7 @@ * * Will be constant time as its generally used in bypass conditions only. * This is necessary until timers are accessible. if you need timed delays - * use @ref mdelay or @udelay instead + * use @ref mdelay or @ref udelay instead * * @param[in] loops number of loops * diff --git a/arch/m68k/lib/m68k-linuxboot.c b/arch/m68k/lib/m68k-linuxboot.c index 63b0cc134..b29e2d5c1 100644 --- a/arch/m68k/lib/m68k-linuxboot.c +++ b/arch/m68k/lib/m68k-linuxboot.c @@ -18,7 +18,8 @@ * along with U-Boot V2. If not, see . */ -/** @file Linux boot preparation code. +/** @file + * @brief Linux boot preparation code. * * This file is responsible to start a linux kernel on * Coldfire targets. diff --git a/board/kp_ukd_r1_num/highlevel_init.c b/board/kp_ukd_r1_num/highlevel_init.c index 11b30f183..a0d4a621a 100644 --- a/board/kp_ukd_r1_num/highlevel_init.c +++ b/board/kp_ukd_r1_num/highlevel_init.c @@ -18,7 +18,8 @@ * along with U-Boot V2. If not, see . */ -/** @file This file contains high-level init functions. +/** @file + * @brief This file contains high-level init functions. * */ #include @@ -115,7 +116,7 @@ void board_init_highlevel(void) /** Provide address of early debug low-level output * - * @fixme Should return real address for UART register map. + * @todo Should return real address for UART register map. */ void *get_early_console_base(const char *name) { diff --git a/board/kp_ukd_r1_num/lowlevel_init.c b/board/kp_ukd_r1_num/lowlevel_init.c index 31b3bb981..7770e101d 100644 --- a/board/kp_ukd_r1_num/lowlevel_init.c +++ b/board/kp_ukd_r1_num/lowlevel_init.c @@ -18,7 +18,8 @@ * along with U-Boot V2. If not, see . */ -/** @file This file contains ... +/** @file + * @brief This file contains ... * */ #include diff --git a/board/kp_ukd_r1_num/pci-stubs.c b/board/kp_ukd_r1_num/pci-stubs.c index 3f2d4563f..4993284c0 100644 --- a/board/kp_ukd_r1_num/pci-stubs.c +++ b/board/kp_ukd_r1_num/pci-stubs.c @@ -18,7 +18,8 @@ * along with U-Boot V2. If not, see . */ -/** @file This file contains callbacks for the PCI subsystem +/** @file + * @brief This file contains callbacks for the PCI subsystem * */ #include diff --git a/board/phycore_mcf54xx/highlevel_init.c b/board/phycore_mcf54xx/highlevel_init.c index 11b30f183..a0d4a621a 100644 --- a/board/phycore_mcf54xx/highlevel_init.c +++ b/board/phycore_mcf54xx/highlevel_init.c @@ -18,7 +18,8 @@ * along with U-Boot V2. If not, see . */ -/** @file This file contains high-level init functions. +/** @file + * @brief This file contains high-level init functions. * */ #include @@ -115,7 +116,7 @@ void board_init_highlevel(void) /** Provide address of early debug low-level output * - * @fixme Should return real address for UART register map. + * @todo Should return real address for UART register map. */ void *get_early_console_base(const char *name) { diff --git a/board/phycore_mcf54xx/lowlevel_init.c b/board/phycore_mcf54xx/lowlevel_init.c index 89ac6ff8d..2f8e9dae2 100644 --- a/board/phycore_mcf54xx/lowlevel_init.c +++ b/board/phycore_mcf54xx/lowlevel_init.c @@ -18,7 +18,8 @@ * along with U-Boot V2. If not, see . */ -/** @file This file contains ... +/** @file + * @brief This file contains ... * */ #include diff --git a/board/phycore_mcf54xx/pci-stubs.c b/board/phycore_mcf54xx/pci-stubs.c index 3f2d4563f..4993284c0 100644 --- a/board/phycore_mcf54xx/pci-stubs.c +++ b/board/phycore_mcf54xx/pci-stubs.c @@ -18,7 +18,8 @@ * along with U-Boot V2. If not, see . */ -/** @file This file contains callbacks for the PCI subsystem +/** @file + * @brief This file contains callbacks for the PCI subsystem * */ #include diff --git a/board/phycore_mcf54xx/phyCore_MCF54xx.c b/board/phycore_mcf54xx/phyCore_MCF54xx.c index 6fe799328..68c2111fa 100644 --- a/board/phycore_mcf54xx/phyCore_MCF54xx.c +++ b/board/phycore_mcf54xx/phyCore_MCF54xx.c @@ -18,7 +18,8 @@ * along with U-Boot V2. If not, see . */ -/** @file This file contains ... +/** @file + * @brief This file contains ... * */ #include diff --git a/commands/bootm.c b/commands/bootm.c index 853f70a32..350d82635 100644 --- a/commands/bootm.c +++ b/commands/bootm.c @@ -595,4 +595,5 @@ void bz_internal_error(int errcode) * - @subpage arm_boot_preparation * - @subpage ppc_boot_preparation * - @subpage x86_boot_preparation + * - @subpage m68k_boot_preparation */