From 4d3017ab2ddb22b461a21cc0e5572793d392d01e Mon Sep 17 00:00:00 2001 From: Ralf Corsepius Date: Thu, 2 Dec 2004 18:04:55 +0000 Subject: Add doxygen preamble. --- cpukit/libcsupport/include/chain.h | 4 ++++ cpukit/libcsupport/include/clockdrv.h | 4 ++++ cpukit/libcsupport/include/console.h | 4 ++++ cpukit/libcsupport/include/iosupp.h | 7 +++++-- cpukit/libcsupport/include/motorola/mc68230.h | 4 ++++ cpukit/libcsupport/include/motorola/mc68681.h | 8 +++++++- cpukit/libcsupport/include/ringbuf.h | 8 +++++--- cpukit/libcsupport/include/rtc.h | 7 +++++-- cpukit/libcsupport/include/rtems/assoc.h | 4 ++++ cpukit/libcsupport/include/rtems/cdefs.h | 4 ++++ cpukit/libcsupport/include/rtems/error.h | 4 ++++ cpukit/libcsupport/include/rtems/libcsupport.h | 4 ++++ cpukit/libcsupport/include/rtems/libio.h | 4 ++++ cpukit/libcsupport/include/rtems/libio_.h | 4 ++++ cpukit/libcsupport/include/rtems/termiostypes.h | 4 ++++ cpukit/libcsupport/include/spurious.h | 4 ++++ cpukit/libcsupport/include/timerdrv.h | 7 +++++-- cpukit/libcsupport/include/vmeintr.h | 8 +++++--- cpukit/libcsupport/include/zilog/z8036.h | 11 +++++------ cpukit/libcsupport/include/zilog/z8530.h | 11 +++++------ cpukit/libcsupport/include/zilog/z8536.h | 7 +++++-- 21 files changed, 95 insertions(+), 27 deletions(-) (limited to 'cpukit/libcsupport/include') diff --git a/cpukit/libcsupport/include/chain.h b/cpukit/libcsupport/include/chain.h index 36c526a614..c39c445f71 100644 --- a/cpukit/libcsupport/include/chain.h +++ b/cpukit/libcsupport/include/chain.h @@ -1,3 +1,7 @@ +/** + * @file rtems/chain.h + */ + /* chain.h * * This include file contains all the constants and structures associated diff --git a/cpukit/libcsupport/include/clockdrv.h b/cpukit/libcsupport/include/clockdrv.h index 1bec3362b0..20394ec096 100644 --- a/cpukit/libcsupport/include/clockdrv.h +++ b/cpukit/libcsupport/include/clockdrv.h @@ -1,3 +1,7 @@ +/** + * @file rtems/clockdrv.h + */ + /* clock.h * * This file describes the Clock Driver for all boards. diff --git a/cpukit/libcsupport/include/console.h b/cpukit/libcsupport/include/console.h index 4c04dde842..a91c5e03ca 100644 --- a/cpukit/libcsupport/include/console.h +++ b/cpukit/libcsupport/include/console.h @@ -1,3 +1,7 @@ +/** + * @file rtems/console.h + */ + /* console.h * * This file describes the Console Device Driver for all boards. diff --git a/cpukit/libcsupport/include/iosupp.h b/cpukit/libcsupport/include/iosupp.h index e8f19d1d8e..721662946f 100644 --- a/cpukit/libcsupport/include/iosupp.h +++ b/cpukit/libcsupport/include/iosupp.h @@ -1,5 +1,8 @@ -/* iosupp.h - * +/** + * @file rtems/iosupp.h + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/libcsupport/include/motorola/mc68230.h b/cpukit/libcsupport/include/motorola/mc68230.h index 952c1cdb3c..f90f714f3d 100644 --- a/cpukit/libcsupport/include/motorola/mc68230.h +++ b/cpukit/libcsupport/include/motorola/mc68230.h @@ -1,3 +1,7 @@ +/** + * @file rtems/motorola/mc68230.h + */ + /* * mc68230.h -- Low level support code for the Motorola 68230 Parallel * Interface/Timer (PIT) diff --git a/cpukit/libcsupport/include/motorola/mc68681.h b/cpukit/libcsupport/include/motorola/mc68681.h index 5196f7ff75..3de1631c2f 100644 --- a/cpukit/libcsupport/include/motorola/mc68681.h +++ b/cpukit/libcsupport/include/motorola/mc68681.h @@ -1,6 +1,12 @@ -/* +/** + * @file rtems/motorola/mc68681.h + * + * * mc68681-duart.h -- Low level support code for the Motorola mc68681 * DUART. + */ + +/* * * Originally written by rob@cygnus.com (Rob Savoye) for the libgloss * IDP support. diff --git a/cpukit/libcsupport/include/ringbuf.h b/cpukit/libcsupport/include/ringbuf.h index 3895b82274..9a03adbb84 100644 --- a/cpukit/libcsupport/include/ringbuf.h +++ b/cpukit/libcsupport/include/ringbuf.h @@ -1,8 +1,10 @@ -/* - * ringbuf.h +/** + * @file rtems/ringbuf.h * * This file provides simple ring buffer functionality. - * + */ + +/* * $Id$ */ diff --git a/cpukit/libcsupport/include/rtc.h b/cpukit/libcsupport/include/rtc.h index 15a089dbd4..c100674d63 100644 --- a/cpukit/libcsupport/include/rtc.h +++ b/cpukit/libcsupport/include/rtc.h @@ -1,9 +1,12 @@ -/* rtc.h +/** + * @file rtems/rtc.h * * This file describes the Real-Time Clock driver for all boards. * This driver provides support for the standard RTEMS routines * that set the tod based on an RTC. - * + */ + +/* * COPYRIGHT (c) 1989-2001. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/libcsupport/include/rtems/assoc.h b/cpukit/libcsupport/include/rtems/assoc.h index 7c5ebe7f6a..8bfa72b9c9 100644 --- a/cpukit/libcsupport/include/rtems/assoc.h +++ b/cpukit/libcsupport/include/rtems/assoc.h @@ -1,3 +1,7 @@ +/** + * @file rtems/assoc.h + */ + /* * * Rtems associativity routines. Mainly used to convert a value from diff --git a/cpukit/libcsupport/include/rtems/cdefs.h b/cpukit/libcsupport/include/rtems/cdefs.h index 6abf3234ca..df4690f3e6 100644 --- a/cpukit/libcsupport/include/rtems/cdefs.h +++ b/cpukit/libcsupport/include/rtems/cdefs.h @@ -1,3 +1,7 @@ +/** + * @file rtems/cdefs.h + */ + /* * Copyright (c) 1991, 1993 * The Regents of the University of California. All rights reserved. diff --git a/cpukit/libcsupport/include/rtems/error.h b/cpukit/libcsupport/include/rtems/error.h index de6e1715db..2a6b0d0a65 100644 --- a/cpukit/libcsupport/include/rtems/error.h +++ b/cpukit/libcsupport/include/rtems/error.h @@ -1,3 +1,7 @@ +/** + * @file rtems/error.h + */ + /* * Defines and externs for rtems error reporting * diff --git a/cpukit/libcsupport/include/rtems/libcsupport.h b/cpukit/libcsupport/include/rtems/libcsupport.h index 8b2223ae9d..1ded3d39ae 100644 --- a/cpukit/libcsupport/include/rtems/libcsupport.h +++ b/cpukit/libcsupport/include/rtems/libcsupport.h @@ -1,3 +1,7 @@ +/** + * @file rtems/libcsupport.h + */ + /* libcsupport.h * * This include file contains the information regarding the diff --git a/cpukit/libcsupport/include/rtems/libio.h b/cpukit/libcsupport/include/rtems/libio.h index 4819be4868..bf1c972766 100644 --- a/cpukit/libcsupport/include/rtems/libio.h +++ b/cpukit/libcsupport/include/rtems/libio.h @@ -1,3 +1,7 @@ +/** + * @file rtems/libio.h + */ + /* * System call and file system interface definition * diff --git a/cpukit/libcsupport/include/rtems/libio_.h b/cpukit/libcsupport/include/rtems/libio_.h index 3662202e2e..bfe18b294a 100644 --- a/cpukit/libcsupport/include/rtems/libio_.h +++ b/cpukit/libcsupport/include/rtems/libio_.h @@ -1,3 +1,7 @@ +/** + * @file rtems/libio_.h + */ + /* * Libio Internal Information * diff --git a/cpukit/libcsupport/include/rtems/termiostypes.h b/cpukit/libcsupport/include/rtems/termiostypes.h index 92f8c97b1c..b4c1369c36 100644 --- a/cpukit/libcsupport/include/rtems/termiostypes.h +++ b/cpukit/libcsupport/include/rtems/termiostypes.h @@ -1,3 +1,7 @@ +/** + * @file rtems/termiostypes.h + */ + /* * RTEMS termios device support internal data structures * diff --git a/cpukit/libcsupport/include/spurious.h b/cpukit/libcsupport/include/spurious.h index 729245fb95..11f9335159 100644 --- a/cpukit/libcsupport/include/spurious.h +++ b/cpukit/libcsupport/include/spurious.h @@ -1,3 +1,7 @@ +/** + * @file rtems/spurious.h + */ + /* spurious.h * * This file describes the Spurious Interrupt Driver for all boards. diff --git a/cpukit/libcsupport/include/timerdrv.h b/cpukit/libcsupport/include/timerdrv.h index 9b1772201e..e91b51272e 100644 --- a/cpukit/libcsupport/include/timerdrv.h +++ b/cpukit/libcsupport/include/timerdrv.h @@ -1,6 +1,10 @@ -/* timerdrv.h +/** + * @file rtems/timerdrv.h * * This file describes the Timer Driver for all boards. + */ + +/* * * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). @@ -36,4 +40,3 @@ void Set_find_average_overhead( #endif #endif -/* end of include file */ diff --git a/cpukit/libcsupport/include/vmeintr.h b/cpukit/libcsupport/include/vmeintr.h index 95d53db263..d2703a583e 100644 --- a/cpukit/libcsupport/include/vmeintr.h +++ b/cpukit/libcsupport/include/vmeintr.h @@ -1,10 +1,12 @@ -/* - * vmeintr.h +/** + * @file rtems/vmeintr.h * * This file is the specification for the VMEbus interface library * which should be provided by all BSPs for VMEbus Single Board * Computers but currently only a few do so. - * + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/libcsupport/include/zilog/z8036.h b/cpukit/libcsupport/include/zilog/z8036.h index b15725a978..ceece53387 100644 --- a/cpukit/libcsupport/include/zilog/z8036.h +++ b/cpukit/libcsupport/include/zilog/z8036.h @@ -1,12 +1,11 @@ -/* z8036.h - * +/** + * @file rtems/zilog/z8036.h + */ + +/* * This include file defines information related to a Zilog Z8036 * Counter/Timer/IO Chip. It is a memory mapped part. * - * Input parameters: NONE - * - * Output parameters: NONE - * * NOTE: This file shares as much as possible with the include * file for the Z8536 via z8x36.h. * diff --git a/cpukit/libcsupport/include/zilog/z8530.h b/cpukit/libcsupport/include/zilog/z8530.h index f77178f8ef..dff8663250 100644 --- a/cpukit/libcsupport/include/zilog/z8530.h +++ b/cpukit/libcsupport/include/zilog/z8530.h @@ -1,12 +1,11 @@ -/* z8530.h - * +/** + * @file rtems/zilog/z8530.h + */ + +/* * This include file defines information related to a Zilog Z8530 * SCC Chip. It is a IO mapped part. * - * Input parameters: NONE - * - * Output parameters: NONE - * * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/libcsupport/include/zilog/z8536.h b/cpukit/libcsupport/include/zilog/z8536.h index 22457c8bca..31d274c0ec 100644 --- a/cpukit/libcsupport/include/zilog/z8536.h +++ b/cpukit/libcsupport/include/zilog/z8536.h @@ -1,5 +1,8 @@ -/* z8536.h - * +/** + * @file rtems/zilog/z8536.h + */ + +/* * This include file defines information related to a Zilog Z8536 * Counter/Timer/IO Chip. It is a IO mapped part. * -- cgit v1.2.3