[PATCH] Some doxygen related fixes
Sascha Hauer
s.hauer at pengutronix.de
Mon Dec 14 03:43:25 EST 2009
On Mon, Dec 14, 2009 at 09:28:51AM +0100, Juergen Beisert wrote:
> 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 <jbe at pengutronix.de>
Ok, applied
Sascha
>
> ---
> 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 80f07f2..ab941e2 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
> + at li @subpage mcfv4e_MCDlib
>
> */
> diff --git a/arch/architecture.dox b/arch/architecture.dox
> index 6ef5ba9..2383852 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
> + at li @subpage dev_m68k_mach
>
> */
>
> diff --git a/arch/arm/cpu/cpu.c b/arch/arm/cpu/cpu.c
> index 180f458..154f8cc 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 418da18..0557172 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 4f70abc..2b25dc1 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 63b0cc1..b29e2d5 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 <http://www.gnu.org/licenses/>.
> */
>
> -/** @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 11b30f1..a0d4a62 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 <http://www.gnu.org/licenses/>.
> */
>
> -/** @file This file contains high-level init functions.
> +/** @file
> + * @brief This file contains high-level init functions.
> *
> */
> #include <common.h>
> @@ -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 31b3bb9..7770e10 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 <http://www.gnu.org/licenses/>.
> */
>
> -/** @file This file contains ...
> +/** @file
> + * @brief This file contains ...
> *
> */
> #include <common.h>
> diff --git a/board/kp_ukd_r1_num/pci-stubs.c b/board/kp_ukd_r1_num/pci-stubs.c
> index 3f2d456..4993284 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 <http://www.gnu.org/licenses/>.
> */
>
> -/** @file This file contains callbacks for the PCI subsystem
> +/** @file
> + * @brief This file contains callbacks for the PCI subsystem
> *
> */
> #include <common.h>
> diff --git a/board/phycore_mcf54xx/highlevel_init.c b/board/phycore_mcf54xx/highlevel_init.c
> index 11b30f1..a0d4a62 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 <http://www.gnu.org/licenses/>.
> */
>
> -/** @file This file contains high-level init functions.
> +/** @file
> + * @brief This file contains high-level init functions.
> *
> */
> #include <common.h>
> @@ -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 89ac6ff..2f8e9da 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 <http://www.gnu.org/licenses/>.
> */
>
> -/** @file This file contains ...
> +/** @file
> + * @brief This file contains ...
> *
> */
> #include <common.h>
> diff --git a/board/phycore_mcf54xx/pci-stubs.c b/board/phycore_mcf54xx/pci-stubs.c
> index 3f2d456..4993284 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 <http://www.gnu.org/licenses/>.
> */
>
> -/** @file This file contains callbacks for the PCI subsystem
> +/** @file
> + * @brief This file contains callbacks for the PCI subsystem
> *
> */
> #include <common.h>
> diff --git a/board/phycore_mcf54xx/phyCore_MCF54xx.c b/board/phycore_mcf54xx/phyCore_MCF54xx.c
> index 6fe7993..68c2111 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 <http://www.gnu.org/licenses/>.
> */
>
> -/** @file This file contains ...
> +/** @file
> + * @brief This file contains ...
> *
> */
> #include <common.h>
> diff --git a/commands/bootm.c b/commands/bootm.c
> index 853f70a..350d826 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
> */
> --
> 1.6.1
>
> --
> Pengutronix e.K. | Juergen Beisert |
> Linux Solutions for Science and Industry | Phone: +49-8766-939 228 |
> Vertretung Sued/Muenchen, Germany | Fax: +49-5121-206917-5555 |
> Amtsgericht Hildesheim, HRA 2686 | http://www.pengutronix.de/ |
>
> _______________________________________________
> u-boot-v2 mailing list
> u-boot-v2 at lists.infradead.org
> http://lists.infradead.org/mailman/listinfo/u-boot-v2
>
--
Pengutronix e.K. | |
Industrial Linux Solutions | http://www.pengutronix.de/ |
Peiner Str. 6-8, 31137 Hildesheim, Germany | Phone: +49-5121-206917-0 |
Amtsgericht Hildesheim, HRA 2686 | Fax: +49-5121-206917-5555 |
More information about the u-boot-v2
mailing list