Changeset 573:a67079b70747

Show
Ignore:
Timestamp:
06/02/08 05:30:24 (7 months ago)
Author:
David Anderson <dave@…>
Branch:
default
Message:

Regroup the documentation for kernel internal APIs.

Location:
nxos/base
Files:
5 modified

Legend:

Unmodified
Added
Removed

  • nxos/base/_abort.h

    r495 r573  
    33 */ 
    44 
    5 /* Copyright (C) 2007 the NxOS developers 
     5/* Copyright (c) 2007,2008 the NxOS developers 
    66 * 
    77 * See AUTHORS for a full list of the developers. 
    … …  
    1414#define __NXOS_BASE__ABORT_H__ 
    1515 
     16/** @addtogroup coreinternal */ 
     17/*@{*/ 
     18 
     19/** Process a data or prefetch abort. 
     20 * 
     21 * @param data TRUE if the abort is a data abort, FALSE if it is a 
     22 * prefetch abort. 
     23 * @param pc The address of the instruction that caused the abort. 
     24 * @param cpsr The CPU state at the time of abort. 
     25 * 
     26 * @note This function never returns, and results in the brick locking 
     27 * up completely. 
     28 */ 
    1629void nx__abort(bool data, U32 pc, U32 cpsr); 
    1730 
     31/*@}*/ 
     32 
    1833#endif /* __NXOS_BASE__ABORT_H__ */ 

  • nxos/base/_core.h

    r492 r573  
    88 */ 
    99 
    10 /* Copyright (C) 2007 the NxOS developers 
     10/* Copyright (c) 2007,2008 the NxOS developers 
    1111 * 
    1212 * See AUTHORS for a full list of the developers. 
    … …  
    2424/*@{*/ 
    2525 
    26 /** @defgroup core Core startup and shutdown 
     26/** @defgroup coreinternal Core startup and shutdown 
    2727 * 
    2828 * The baseplate's main() is private. 

  • nxos/base/_display.h

    r489 r573  
    33 */ 
    44 
    5 /* Copyright (C) 2007 the NxOS developers 
     5/* Copyright (c) 2007,2008 the NxOS developers 
    66 * 
    77 * See AUTHORS for a full list of the developers. 
    … …  
    1919/*@{*/ 
    2020 
    21 /** @name Display internals. 
     21/** @defgroup displayinternal Display internals 
    2222 * 
    2323 * The display's initialization function is private, since the baseplate 

  • nxos/base/_font.h.base

    r333 r573  
    1 /** 
    2  * Font file template 
     1/** @file _font.h 
     2 *  @brief Embedded font data. 
     3 */ 
     4 
     5/* Copyright (c) 2008 the NxOS developers 
     6 * 
     7 * See AUTHORS for a full list of the developers. 
     8 * 
     9 * Redistribution of this file is permitted under 
     10 * the terms of the GNU Public License (GPL) version 2. 
    311 */ 
    412 
    … …  
    1220/*@{*/ 
    1321 
    14 /** @name Font data 
     22/** @defgroup fontinternal Font data 
    1523 * 
    1624 * A basic font is embedded into the baseplate, for use by the display 

  • nxos/base/_fs.h

    r537 r573  
    55 */ 
    66 
    7 /* Copyright (C) 2008 the NxOS developers 
     7/* Copyright (c) 2008 the NxOS developers 
    88 * 
    99 * See AUTHORS for a full list of the developers. 
    … …  
    2222/*@{*/ 
    2323 
    24 /** @name File system internals. 
     24/** @defgroup fsinternal File system internals 
    2525 * 
    2626 */