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 <jbe@pengutronix.de>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
This commit is contained in:
Juergen Beisert
Sascha Hauer
parent
e2b4a792f8
commit
f522d42597
|
|
@ -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
|
||||
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -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) {
|
||||
|
|
|
|||
|
|
@ -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?
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -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
|
||||
*
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -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>
|
||||
|
|
|
|||
|
|
@ -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>
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -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>
|
||||
|
|
|
|||
|
|
@ -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>
|
||||
|
|
|
|||
|
|
@ -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>
|
||||
|
|
|
|||
|
|
@ -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
|
||||
*/
|
||||
|
|
|
|||
Loading…
Reference in New Issue