Changeset cf26ba9 in mainline


Ignore:
Timestamp:
2006-05-01T12:24:32Z (19 years ago)
Author:
Jakub Jermar <jakub@…>
Branches:
lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export
Children:
953b0f33
Parents:
ea199e5
Message:

Improve Doxygen-comments.

Location:
generic
Files:
24 edited

Legend:

Unmodified
Added
Removed

  • generic/include/security/cap.h

    rea199e5 rcf26ba9  
    2828
    2929/**
    30  * Capabilities definitions.
     30 * @file        cap.h
     31 * @brief       Capabilities definitions.
     32 *
     33 * Capabilities represent virtual rights that entitle their
     34 * holder to perform certain security sensitive tasks.
     35 *
    3136 * Each task can have arbitrary combination of the capabilities
    3237 * defined in this file. Therefore, they are required to be powers

  • generic/src/console/cmd.c

    rea199e5 rcf26ba9  
    2828
    2929/**
     30 * @file        cmd.c
     31 * @brief       Kernel console command wrappers.
     32 *
    3033 * This file is meant to contain all wrapper functions for
    3134 * all kconsole commands. The point is in separating

  • generic/src/console/kconsole.c

    rea199e5 rcf26ba9  
    2525 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
    2626 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     27 */
     28
     29/**
     30 * @file        kconsole.c
     31 * @brief       Kernel console.
     32 *
     33 * This file contains kernel thread managing the kernel console.
    2734 */
    2835

  • generic/src/cpu/cpu.c

    rea199e5 rcf26ba9  
    2727 */
    2828
     29/**
     30 * @file        cpu.c
     31 * @brief       CPU subsystem initialization and listing.
     32 */
     33 
    2934#include <cpu.h>
    3035#include <arch.h>

  • generic/src/debug/print.c

    rea199e5 rcf26ba9  
    2626 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
    2727 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     28 */
     29
     30/**
     31 * @file        print.c
     32 * @brief       Printing functions.
    2833 */
    2934

  • generic/src/debug/symtab.c

    rea199e5 rcf26ba9  
    2727 */
    2828
     29/**
     30 * @file        symtab.c
     31 * @brief       Kernel symbol resolver.
     32 */
    2933
    3034#include <symtab.h>
    … …  
    3438#include <print.h>
    3539
    36 /** Return entry that seems most likely to correspond to address
     40/** Return entry that seems most likely to correspond to argument.
    3741 *
    3842 * Return entry that seems most likely to correspond
    … …  
    5660}
    5761
    58 /** Find symbols that match the parameter forward and print them 
     62/** Find symbols that match the parameter forward and print them.
    5963 *
    6064 * @param name - search string

  • generic/src/interrupt/interrupt.c

    rea199e5 rcf26ba9  
    2525 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
    2626 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     27 */
     28
     29/**
     30 * @file        interrupt.c
     31 * @brief       Interrupt redirector.
     32 *
     33 * This file provides means of registering interrupt handlers
     34 * by kernel functions and calling the handlers when interrupts
     35 * occur.
    2736 */
    2837

  • generic/src/lib/elf.c

    rea199e5 rcf26ba9  
    2727 */
    2828
     29/**
     30 * @file        elf.c
     31 * @brief       Kernel ELF loader.
     32 */
     33
    2934#include <elf.h>
    3035#include <debug.h>

  • generic/src/lib/func.c

    rea199e5 rcf26ba9  
    2525 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
    2626 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     27 */
     28
     29/**
     30 * @file        func.c
     31 * @brief       Miscellaneous functions.
    2732 */
    2833

  • generic/src/lib/memstr.c

    rea199e5 rcf26ba9  
    2525 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
    2626 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     27 */
     28
     29/**
     30 * @file        memstr.c
     31 * @brief       Memory string operations.
     32 *
     33 * This file provides architecture independent functions
     34 * to manipulate blocks of memory. These functions
     35 * are optimized as much as generic functions of
     36 * this type can be. However, architectures are
     37 * free to provide even more optimized versions of these
     38 * functions.
    2739 */
    2840

  • generic/src/lib/sort.c

    rea199e5 rcf26ba9  
    2727 */
    2828
     29/**
     30 * @file        sort.c
     31 * @brief       Sorting functions.
     32 *
     33 * This files contains functions implementing several sorting
     34 * algorithms (e.g. quick sort and bubble sort).
     35 */
     36 
    2937#include <mm/slab.h>
    3038#include <memstr.h>

  • generic/src/preempt/preemption.c

    rea199e5 rcf26ba9  
    2727 */
    2828
     29/**
     30 * @file        preemption.c
     31 * @brief       Preemption control.
     32 */
     33 
    2934#include <preemption.h>
    3035#include <arch.h>

  • generic/src/proc/scheduler.c

    rea199e5 rcf26ba9  
    3131 * @brief       Scheduler and load balancing.
    3232 *
    33  * This file contains the scheduler and kcpulb kernel thread wich
     33 * This file contains the scheduler and kcpulb kernel thread which
    3434 * performs load-balancing of per-CPU run queues.
    3535 */

  • generic/src/security/cap.c

    rea199e5 rcf26ba9  
    2727 */
    2828
     29/**
     30 * @file        cap.c
     31 * @brief       Capabilities control.
     32 *
     33 * @see cap.h
     34 */
     35 
    2936#include <security/cap.h>
    3037#include <proc/task.h>

  • generic/src/smp/ipi.c

    rea199e5 rcf26ba9  
    2727 */
    2828
     29/**
     30 * @file        ipi.c
     31 * @brief       Generic IPI interface.
     32 */
     33 
    2934#ifdef CONFIG_SMP
    3035
    … …  
    3944 * @param ipi Message to broadcast.
    4045 *
     46 * @bugs The decision whether to actually send the IPI must be based
     47 *       on a different criterion. The current version has
     48 *       problems when some of the detected CPUs are marked
     49 *       disabled in machine configuration.
    4150 */
    4251void ipi_broadcast(int ipi)

  • generic/src/synch/condvar.c

    rea199e5 rcf26ba9  
    2525 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
    2626 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     27 */
     28
     29/**
     30 * @file        condvar.c
     31 * @brief       Condition variables.
    2732 */
    2833

  • generic/src/synch/futex.c

    rea199e5 rcf26ba9  
    2828
    2929/**
    30  * Kernel backend for futexes.
    31  * Deallocation of orphaned kernel-side futex structures is not currently implemented.
     30 * @file        futex.c
     31 * @brief       Kernel backend for futexes.
     32 *
     33 * @todo Deallocation of orphaned kernel-side futex structures is not currently implemented.
    3234 */
    3335

  • generic/src/synch/mutex.c

    rea199e5 rcf26ba9  
    2727 */
    2828
     29/**
     30 * @file        mutex.c
     31 * @brief       Mutexes.
     32 */
     33 
    2934#include <synch/mutex.h>
    3035#include <synch/semaphore.h>

  • generic/src/synch/semaphore.c

    rea199e5 rcf26ba9  
    2525 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
    2626 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     27 */
     28
     29/**
     30 * @file        semaphore.c
     31 * @brief       Semaphores.
    2732 */
    2833

  • generic/src/synch/spinlock.c

    rea199e5 rcf26ba9  
    2727 */
    2828
     29/**
     30 * @file        spinlock.c
     31 * @brief       Spinlocks.
     32 */
     33 
    2934#include <synch/spinlock.h>
    3035#include <atomic.h>

  • generic/src/syscall/syscall.c

    rea199e5 rcf26ba9  
    2727 */
    2828
     29/**
     30 * @file        syscall.c
     31 * @brief       Syscall table and syscall wrappers.
     32 */
     33 
    2934#include <syscall/syscall.h>
    3035#include <proc/thread.h>

  • generic/src/time/clock.c

    rea199e5 rcf26ba9  
    2727 */
    2828
     29/**
     30 * @file        clock.c
     31 * @brief       High-level clock interrupt handler.
     32 *
     33 * This file contains the clock() function which is the source
     34 * of preemption. It is also responsible for executing expired
     35 * timeouts.
     36 */
     37 
    2938#include <time/clock.h>
    3039#include <time/timeout.h>

  • generic/src/time/delay.c

    rea199e5 rcf26ba9  
    2727 */
    2828
     29/**
     30 * @file        delay.c
     31 * @brief       Active delay function.
     32 */
     33 
    2934#include <time/delay.h>
    3035#include <arch/types.h>

  • generic/src/time/timeout.c

    rea199e5 rcf26ba9  
    2525 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
    2626 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     27 */
     28
     29/**
     30 * @file        timeout.c
     31 * @brief       Timeout management functions.
    2732 */
    2833
Note: See TracChangeset for help on using the changeset viewer.