9
0
Fork 0

basic doc structure added

This commit is contained in:
Juergen Beisert 2007-10-19 13:19:43 +02:00
parent f855f6e865
commit b21ed7177c
10 changed files with 91 additions and 1 deletions

15
Documentation/boards.dox Normal file
View File

@ -0,0 +1,15 @@
/** @page supported_boards
This is a list of boards that are currently supported by UBootv2.
*/
/* TODO
*
* Add documentation to your boardfile, forward it with doxygen's page
* feature (@page <reference>) and include it here with:
*
* @subpage <reference>
*
*/

View File

@ -0,0 +1,13 @@
/** @page developers_manual Developer's Manual
FIXME: Hints and tips for simply adapting UBootv2
@subpage dev_board
@subpage dev_cpu
@subpage dev_architecture
@subpage dev_params
*/

View File

@ -214,4 +214,10 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston,
MA 02111-1307 USA
@endverbatim
@subpage users_manual
@subpage developers_manual
@subpage supported_boards
*/

View File

@ -0,0 +1,8 @@
/** @page users_manual User's Manual
FIXME: Hints and tips for simply using UBootv2
@subpage command_reference
@subpage partitions
*/

View File

@ -464,7 +464,8 @@ INPUT = Documentation \
arch \
drivers \
commands \
common
common \
board
# If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp

15
arch/architecture.dox Normal file
View File

@ -0,0 +1,15 @@
/** @page dev_architecture Integrate a new architecture (ARCH)
Friesel
*/
/** @page dev_cpu Intergrate a new CPU (MACH)
Frasel
@subpage dev_arm_mach
@subpage dev_bf_mach
@subpage dev_ppc_mach
*/

9
arch/arm/mach-arm.dox Normal file
View File

@ -0,0 +1,9 @@
/* This document is intended to provide the developer with information
* how to integrate a new CPU (MACH) into this part of the UBoot tree
*/
/** @page dev_arm_mach ARM based CPU (MACH) into the tree
FIXME
*/

View File

@ -0,0 +1,9 @@
/* This document is intended to provide the developer with information
* how to integrate a new CPU (MACH) into this part of the UBoot tree
*/
/** @page dev_bf_mach Blackfin based CPU (MACH) into the tree
FIXME
*/

9
arch/ppc/mach-ppc.dox Normal file
View File

@ -0,0 +1,9 @@
/* This document is intended to provide the developer with information
* how to integrate a new CPU (MACH) into this part of the UBoot tree
*/
/** @page dev_ppc_mach PowerPC based CPU into the tree
FIXME
*/

5
board/board.dox Normal file
View File

@ -0,0 +1,5 @@
/** @page dev_board Intergrating a new board
Blablubb
*/