Changeset f9293df in rtems


Ignore:
Timestamp:
Apr 18, 2008, 8:08:08 PM (13 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, 4.9, 5, master
Children:
6096728
Parents:
067a96a
Message:

2008-04-18 Joel Sherrill <joel.sherrill@…>

  • rtems/Doxyfile, rtems/include/rtems/rtems/asr.h, rtems/include/rtems/rtems/attr.h, rtems/include/rtems/rtems/barrier.h, rtems/include/rtems/rtems/barriermp.h, rtems/include/rtems/rtems/cache.h, rtems/include/rtems/rtems/config.h, rtems/include/rtems/rtems/dpmem.h, rtems/include/rtems/rtems/event.h, rtems/include/rtems/rtems/eventmp.h, rtems/include/rtems/rtems/eventset.h, rtems/include/rtems/rtems/intr.h, rtems/include/rtems/rtems/message.h, rtems/include/rtems/rtems/modes.h, rtems/include/rtems/rtems/mp.h, rtems/include/rtems/rtems/msgmp.h, rtems/include/rtems/rtems/options.h, rtems/include/rtems/rtems/part.h, rtems/include/rtems/rtems/partmp.h, rtems/include/rtems/rtems/ratemon.h, rtems/include/rtems/rtems/region.h, rtems/include/rtems/rtems/regionmp.h, rtems/include/rtems/rtems/rtemsapi.h, rtems/include/rtems/rtems/sem.h, rtems/include/rtems/rtems/semmp.h, rtems/include/rtems/rtems/signal.h, rtems/include/rtems/rtems/signalmp.h, rtems/include/rtems/rtems/status.h, rtems/include/rtems/rtems/support.h, rtems/include/rtems/rtems/taskmp.h, rtems/include/rtems/rtems/tasks.h, rtems/include/rtems/rtems/timer.h, rtems/include/rtems/rtems/types.h, rtems/inline/rtems/rtems/asr.inl, rtems/inline/rtems/rtems/attr.inl, rtems/inline/rtems/rtems/barrier.inl, rtems/inline/rtems/rtems/dpmem.inl, rtems/inline/rtems/rtems/event.inl, rtems/inline/rtems/rtems/message.inl, rtems/inline/rtems/rtems/modes.inl, rtems/inline/rtems/rtems/options.inl, rtems/inline/rtems/rtems/part.inl, rtems/inline/rtems/rtems/ratemon.inl, rtems/inline/rtems/rtems/region.inl, rtems/inline/rtems/rtems/sem.inl, rtems/inline/rtems/rtems/status.inl, rtems/inline/rtems/rtems/support.inl, rtems/inline/rtems/rtems/timer.inl: More Doxygen improvements.
Location:
cpukit
Files:
49 edited

Legend:

Unmodified
Added
Removed
  • cpukit/ChangeLog

    r067a96a rf9293df  
     12008-04-18      Joel Sherrill <joel.sherrill@oarcorp.com>
     2
     3        * rtems/Doxyfile, rtems/include/rtems/rtems/asr.h,
     4        rtems/include/rtems/rtems/attr.h,
     5        rtems/include/rtems/rtems/barrier.h,
     6        rtems/include/rtems/rtems/barriermp.h,
     7        rtems/include/rtems/rtems/cache.h,
     8        rtems/include/rtems/rtems/config.h,
     9        rtems/include/rtems/rtems/dpmem.h, rtems/include/rtems/rtems/event.h,
     10        rtems/include/rtems/rtems/eventmp.h,
     11        rtems/include/rtems/rtems/eventset.h,
     12        rtems/include/rtems/rtems/intr.h,
     13        rtems/include/rtems/rtems/message.h,
     14        rtems/include/rtems/rtems/modes.h, rtems/include/rtems/rtems/mp.h,
     15        rtems/include/rtems/rtems/msgmp.h,
     16        rtems/include/rtems/rtems/options.h,
     17        rtems/include/rtems/rtems/part.h, rtems/include/rtems/rtems/partmp.h,
     18        rtems/include/rtems/rtems/ratemon.h,
     19        rtems/include/rtems/rtems/region.h,
     20        rtems/include/rtems/rtems/regionmp.h,
     21        rtems/include/rtems/rtems/rtemsapi.h,
     22        rtems/include/rtems/rtems/sem.h, rtems/include/rtems/rtems/semmp.h,
     23        rtems/include/rtems/rtems/signal.h,
     24        rtems/include/rtems/rtems/signalmp.h,
     25        rtems/include/rtems/rtems/status.h,
     26        rtems/include/rtems/rtems/support.h,
     27        rtems/include/rtems/rtems/taskmp.h,
     28        rtems/include/rtems/rtems/tasks.h, rtems/include/rtems/rtems/timer.h,
     29        rtems/include/rtems/rtems/types.h, rtems/inline/rtems/rtems/asr.inl,
     30        rtems/inline/rtems/rtems/attr.inl,
     31        rtems/inline/rtems/rtems/barrier.inl,
     32        rtems/inline/rtems/rtems/dpmem.inl,
     33        rtems/inline/rtems/rtems/event.inl,
     34        rtems/inline/rtems/rtems/message.inl,
     35        rtems/inline/rtems/rtems/modes.inl,
     36        rtems/inline/rtems/rtems/options.inl,
     37        rtems/inline/rtems/rtems/part.inl,
     38        rtems/inline/rtems/rtems/ratemon.inl,
     39        rtems/inline/rtems/rtems/region.inl,
     40        rtems/inline/rtems/rtems/sem.inl,
     41        rtems/inline/rtems/rtems/status.inl,
     42        rtems/inline/rtems/rtems/support.inl,
     43        rtems/inline/rtems/rtems/timer.inl: More Doxygen improvements.
     44
    1452008-04-18      Joel Sherrill <joel.sherrill@oarcorp.com>
    246
  • cpukit/rtems/Doxyfile

    r067a96a rf9293df  
    1 # Doxyfile 1.3.4
     1# Doxyfile 1.5.5
    22
    33# This file describes the settings to be used by the documentation system
     
    1515#---------------------------------------------------------------------------
    1616
     17# This tag specifies the encoding used for all characters in the config file
     18# that follow. The default is UTF-8 which is also the encoding used for all
     19# text before the first occurrence of this tag. Doxygen uses libiconv (or the
     20# iconv built into libc) for the transcoding. See
     21# http://www.gnu.org/software/libiconv for the list of possible encodings.
     22
     23DOXYFILE_ENCODING      = UTF-8
     24
    1725# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
    1826# by quotes) that should identify the project.
    1927
    20 PROJECT_NAME           = RTEMS Classic API
     28PROJECT_NAME           = RTEMSClassicAPI
    2129
    2230# The PROJECT_NUMBER tag can be used to enter a project or revision number.
     
    3341OUTPUT_DIRECTORY       = classic_doxy
    3442
     43# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
     44# 4096 sub-directories (in 2 levels) under the output directory of each output
     45# format and will distribute the generated files over these directories.
     46# Enabling this option can be useful when feeding doxygen a huge amount of
     47# source files, where putting all generated files in the same directory would
     48# otherwise cause performance problems for the file system.
     49
     50CREATE_SUBDIRS         = NO
     51
    3552# The OUTPUT_LANGUAGE tag is used to specify the language in which all
    3653# documentation generated by doxygen is written. Doxygen will use this
    3754# information to generate all constant output in the proper language.
    3855# The default language is English, other supported languages are:
    39 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
    40 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
    41 # (Japanese with English messages), Korean, Norwegian, Polish, Portuguese,
    42 # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
     56# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
     57# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
     58# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
     59# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
     60# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
     61# and Ukrainian.
    4362
    4463OUTPUT_LANGUAGE        = English
    45 
    46 # This tag can be used to specify the encoding used in the generated output.
    47 # The encoding is not always determined by the language that is chosen,
    48 # but also whether or not the output is meant for Windows or non-Windows users.
    49 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
    50 # forces the Windows encoding (this is the default for the Windows binary),
    51 # whereas setting the tag to NO uses a Unix-style encoding (the default for
    52 # all platforms other than Windows).
    53 
    54 USE_WINDOWS_ENCODING   = NO
    5564
    5665# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
     
    6877REPEAT_BRIEF           = YES
    6978
     79# This tag implements a quasi-intelligent brief description abbreviator
     80# that is used to form the text in various listings. Each string
     81# in this list, if found as the leading text of the brief description, will be
     82# stripped from the text and the result after processing the whole list, is
     83# used as the annotated text. Otherwise, the brief description is used as-is.
     84# If left blank, the following values are used ("$name" is automatically
     85# replaced with the name of the entity): "The $name class" "The $name widget"
     86# "The $name file" "is" "provides" "specifies" "contains"
     87# "represents" "a" "an" "the"
     88
     89ABBREVIATE_BRIEF       =
     90
    7091# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
    7192# Doxygen will generate a detailed section even if there is only a brief
     
    7495ALWAYS_DETAILED_SEC    = NO
    7596
    76 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
    77 # members of a class in the documentation of that class as if those members were
    78 # ordinary class members. Constructors, destructors and assignment operators of
    79 # the base classes will not be shown.
     97# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
     98# inherited members of a class in the documentation of that class as if those
     99# members were ordinary class members. Constructors, destructors and assignment
     100# operators of the base classes will not be shown.
    80101
    81102INLINE_INHERITED_MEMB  = NO
     
    90111# can be used to strip a user-defined part of the path. Stripping is
    91112# only done if one of the specified strings matches the left-hand part of
    92 # the path. It is allowed to use relative paths in the argument list.
     113# the path. The tag can be used to show relative paths in the file list.
     114# If left blank the directory from which doxygen is run is used as the
     115# path to strip.
    93116
    94117STRIP_FROM_PATH        =
     118
     119# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
     120# the path mentioned in the documentation of a class, which tells
     121# the reader which header file to include in order to use a class.
     122# If left blank only the name of the header file containing the class
     123# definition is used. Otherwise one should specify the include paths that
     124# are normally passed to the compiler using the -I flag.
     125
     126STRIP_FROM_INC_PATH    =
    95127
    96128# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
     
    103135# will interpret the first line (until the first dot) of a JavaDoc-style
    104136# comment as the brief description. If set to NO, the JavaDoc
    105 # comments will behave just like the Qt-style comments (thus requiring an
    106 # explict @brief command for a brief description.
     137# comments will behave just like regular Qt-style comments
     138# (thus requiring an explicit @brief command for a brief description.)
    107139
    108140JAVADOC_AUTOBRIEF      = NO
     141
     142# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
     143# interpret the first line (until the first dot) of a Qt-style
     144# comment as the brief description. If set to NO, the comments
     145# will behave just like regular Qt-style comments (thus requiring
     146# an explicit \brief command for a brief description.)
     147
     148QT_AUTOBRIEF           = NO
    109149
    110150# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
     
    125165# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
    126166# member inherits the documentation from any documented member that it
    127 # reimplements.
     167# re-implements.
    128168
    129169INHERIT_DOCS           = YES
    130170
    131 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
    132 # tag is set to YES, then doxygen will reuse the documentation of the first
    133 # member in the group (if any) for the other members of the group. By default
    134 # all members of a group must be documented explicitly.
    135 
    136 DISTRIBUTE_GROUP_DOC   = NO
     171# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
     172# a new page for each member. If set to NO, the documentation of a member will
     173# be part of the file/class/namespace that contains it.
     174
     175SEPARATE_MEMBER_PAGES  = NO
    137176
    138177# The TAB_SIZE tag can be used to set the number of spaces in a tab.
     
    150189ALIASES                =
    151190
    152 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
    153 # only. Doxygen will then generate output that is more tailored for C.
     191# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
     192# sources only. Doxygen will then generate output that is more tailored for C.
    154193# For instance, some of the names that are used will be different. The list
    155194# of all members will be omitted, etc.
     
    157196OPTIMIZE_OUTPUT_FOR_C  = YES
    158197
    159 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
    160 # only. Doxygen will then generate output that is more tailored for Java.
    161 # For instance, namespaces will be presented as packages, qualified scopes
    162 # will look different, etc.
     198# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
     199# sources only. Doxygen will then generate output that is more tailored for
     200# Java. For instance, namespaces will be presented as packages, qualified
     201# scopes will look different, etc.
    163202
    164203OPTIMIZE_OUTPUT_JAVA   = NO
     204
     205# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
     206# sources only. Doxygen will then generate output that is more tailored for
     207# Fortran.
     208
     209OPTIMIZE_FOR_FORTRAN   = NO
     210
     211# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
     212# sources. Doxygen will then generate output that is tailored for
     213# VHDL.
     214
     215OPTIMIZE_OUTPUT_VHDL   = NO
     216
     217# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
     218# to include (a tag file for) the STL sources as input, then you should
     219# set this tag to YES in order to let doxygen match functions declarations and
     220# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
     221# func(std::string) {}). This also make the inheritance and collaboration
     222# diagrams that involve STL classes more complete and accurate.
     223
     224BUILTIN_STL_SUPPORT    = NO
     225
     226# If you use Microsoft's C++/CLI language, you should set this option to YES to
     227# enable parsing support.
     228
     229CPP_CLI_SUPPORT        = NO
     230
     231# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
     232# Doxygen will parse them like normal C++ but will assume all classes use public
     233# instead of private inheritance when no explicit protection keyword is present.
     234
     235SIP_SUPPORT            = NO
     236
     237# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
     238# tag is set to YES, then doxygen will reuse the documentation of the first
     239# member in the group (if any) for the other members of the group. By default
     240# all members of a group must be documented explicitly.
     241
     242DISTRIBUTE_GROUP_DOC   = NO
    165243
    166244# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
     
    172250SUBGROUPING            = YES
    173251
     252# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
     253# is documented as struct, union, or enum with the name of the typedef. So
     254# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
     255# with name TypeT. When disabled the typedef will appear as a member of a file,
     256# namespace, or class. And the struct will be named TypeS. This can typically
     257# be useful for C code in case the coding convention dictates that all compound
     258# types are typedef'ed and only the typedef is referenced, never the tag name.
     259
     260TYPEDEF_HIDES_STRUCT   = NO
     261
    174262#---------------------------------------------------------------------------
    175263# Build related configuration options
     
    198286
    199287EXTRACT_LOCAL_CLASSES  = YES
     288
     289# This flag is only useful for Objective-C code. When set to YES local
     290# methods, which are defined in the implementation section but not in
     291# the interface are included in the documentation.
     292# If set to NO (the default) only methods in the interface are included.
     293
     294EXTRACT_LOCAL_METHODS  = NO
     295
     296# If this flag is set to YES, the members of anonymous namespaces will be
     297# extracted and appear in the documentation as a namespace called
     298# 'anonymous_namespace{file}', where file will be replaced with the base
     299# name of the file that contains the anonymous namespace. By default
     300# anonymous namespace are hidden.
     301
     302EXTRACT_ANON_NSPACES   = NO
    200303
    201304# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
     
    239342# allowed. This is useful if you have classes or files whose names only differ
    240343# in case and if your file system supports case sensitive file names. Windows
    241 # users are advised to set this option to NO.
     344# and Mac users are advised to set this option to NO.
    242345
    243346CASE_SENSE_NAMES       = YES
     
    266369
    267370SORT_MEMBER_DOCS       = YES
     371
     372# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
     373# brief documentation of file, namespace and class members alphabetically
     374# by member name. If set to NO (the default) the members will appear in
     375# declaration order.
     376
     377SORT_BRIEF_DOCS        = NO
     378
     379# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
     380# hierarchy of group names into alphabetical order. If set to NO (the default)
     381# the group names will appear in their defined order.
     382
     383SORT_GROUP_NAMES       = NO
     384
     385# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
     386# sorted by fully-qualified names, including namespaces. If set to
     387# NO (the default), the class list will be sorted only by class name,
     388# not including the namespace part.
     389# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
     390# Note: This option applies only to the class list, not to the
     391# alphabetical list.
     392
     393SORT_BY_SCOPE_NAME     = NO
    268394
    269395# The GENERATE_TODOLIST tag can be used to enable (YES) or
     
    312438SHOW_USED_FILES        = YES
    313439
     440# If the sources in your project are distributed over multiple directories
     441# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
     442# in the documentation. The default is NO.
     443
     444SHOW_DIRECTORIES       = NO
     445
     446# The FILE_VERSION_FILTER tag can be used to specify a program or script that
     447# doxygen should invoke to get the current version for each file (typically from
     448# the version control system). Doxygen will invoke the program by executing (via
     449# popen()) the command <command> <input-file>, where <command> is the value of
     450# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
     451# provided by doxygen. Whatever the program writes to standard output
     452# is used as the file version. See the manual for examples.
     453
     454FILE_VERSION_FILTER    =
     455
    314456#---------------------------------------------------------------------------
    315457# configuration options related to warning and progress messages
     
    340482WARN_IF_DOC_ERROR      = YES
    341483
     484# This WARN_NO_PARAMDOC option can be abled to get warnings for
     485# functions that are documented, but have no documentation for their parameters
     486# or return value. If set to NO (the default) doxygen will only warn about
     487# wrong or incomplete parameter documentation, but not about the absence of
     488# documentation.
     489
     490WARN_NO_PARAMDOC       = NO
     491
    342492# The WARN_FORMAT tag determines the format of the warning messages that
    343493# doxygen can produce. The string should contain the $file, $line, and $text
    344494# tags, which will be replaced by the file and line number from which the
    345 # warning originated and the warning text.
     495# warning originated and the warning text. Optionally the format may contain
     496# $version, which will be replaced by the version of the file (if it could
     497# be obtained via FILE_VERSION_FILTER)
    346498
    347499WARN_FORMAT            = "$file:$line: $text"
     
    362514# with spaces.
    363515
    364 INPUT                  = include inline
     516INPUT                  = mainpage.h include \
     517                         inline
     518
     519# This tag can be used to specify the character encoding of the source files
     520# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
     521# also the default input encoding. Doxygen uses libiconv (or the iconv built
     522# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
     523# the list of possible encodings.
     524
     525INPUT_ENCODING         = UTF-8
    365526
    366527# If the value of the INPUT tag contains directories, you can use the
     
    368529# and *.h) to filter out the source-files in the directories. If left
    369530# blank the following patterns are tested:
    370 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
    371 # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc
    372 
    373 FILE_PATTERNS          = *.h *.inl
     531# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
     532# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
     533
     534FILE_PATTERNS          = *.h \
     535                         *.inl
    374536
    375537# The RECURSIVE tag can be used to turn specify whether or not subdirectories
     
    385547EXCLUDE                =
    386548
    387 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
    388 # that are symbolic links (a Unix filesystem feature) are excluded from the input.
     549# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
     550# directories that are symbolic links (a Unix filesystem feature) are excluded
     551# from the input.
    389552
    390553EXCLUDE_SYMLINKS       = NO
     
    392555# If the value of the INPUT tag contains directories, you can use the
    393556# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
    394 # certain files from those directories.
     557# certain files from those directories. Note that the wildcards are matched
     558# against the file with absolute path, so to exclude all test directories
     559# for example use the pattern */test/*
    395560
    396561EXCLUDE_PATTERNS       =
     562
     563# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
     564# (namespaces, classes, functions, etc.) that should be excluded from the
     565# output. The symbol name can be a fully qualified name, a word, or if the
     566# wildcard * is used, a substring. Examples: ANamespace, AClass,
     567# AClass::ANamespace, ANamespace::*Test
     568
     569EXCLUDE_SYMBOLS        =
    397570
    398571# The EXAMPLE_PATH tag can be used to specify one or more files or
     
    427600# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
    428601# input file. Doxygen will then use the output that the filter program writes
    429 # to standard output.
     602# to standard output.  If FILTER_PATTERNS is specified, this tag will be
     603# ignored.
    430604
    431605INPUT_FILTER           =
     606
     607# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
     608# basis.  Doxygen will compare the file name with each pattern and apply the
     609# filter if there is a match.  The filters are a list of the form:
     610# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
     611# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
     612# is applied to all files.
     613
     614FILTER_PATTERNS        =
    432615
    433616# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
     
    442625
    443626# If the SOURCE_BROWSER tag is set to YES then a list of source files will
    444 # be generated. Documented entities will be cross-referenced with these sources.
     627# be generated. Documented entities will be cross-referenced with these sources.
     628# Note: To get rid of all source code in the generated output, make sure also
     629# VERBATIM_HEADERS is set to NO.
    445630
    446631SOURCE_BROWSER         = NO
     
    468653
    469654REFERENCES_RELATION    = YES
     655
     656# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
     657# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
     658# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
     659# link to the source code.  Otherwise they will link to the documentstion.
     660
     661REFERENCES_LINK_SOURCE = YES
     662
     663# If the USE_HTAGS tag is set to YES then the references to source code
     664# will point to the HTML generated by the htags(1) tool instead of doxygen
     665# built-in source browser. The htags tool is part of GNU's global source
     666# tagging system (see http://www.gnu.org/software/global/global.html). You
     667# will need version 4.8.6 or higher.
     668
     669USE_HTAGS              = NO
    470670
    471671# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
     
    534734# style sheet that is used by each HTML page. It can be used to
    535735# fine-tune the look of the HTML output. If the tag is left blank doxygen
    536 # will generate a default style sheet
     736# will generate a default style sheet. Note that doxygen will try to copy
     737# the style sheet file to the HTML output directory, so don't put your own
     738# stylesheet in the HTML output directory as well, or it will be erased!
    537739
    538740HTML_STYLESHEET        =
     
    546748# If the GENERATE_HTMLHELP tag is set to YES, additional index files
    547749# will be generated that can be used as input for tools like the
    548 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
     750# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
    549751# of the generated HTML documentation.
    550752
    551753GENERATE_HTMLHELP      = NO
     754
     755# If the GENERATE_DOCSET tag is set to YES, additional index files
     756# will be generated that can be used as input for Apple's Xcode 3
     757# integrated development environment, introduced with OSX 10.5 (Leopard).
     758# To create a documentation set, doxygen will generate a Makefile in the
     759# HTML output directory. Running make will produce the docset in that
     760# directory and running "make install" will install the docset in
     761# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
     762# it at startup.
     763
     764GENERATE_DOCSET        = NO
     765
     766# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
     767# feed. A documentation feed provides an umbrella under which multiple
     768# documentation sets from a single provider (such as a company or product suite)
     769# can be grouped.
     770
     771DOCSET_FEEDNAME        = "Doxygen generated docs"
     772
     773# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
     774# should uniquely identify the documentation set bundle. This should be a
     775# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
     776# will append .docset to the name.
     777
     778DOCSET_BUNDLE_ID       = org.doxygen.Project
     779
     780# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
     781# documentation will contain sections that can be hidden and shown after the
     782# page has loaded. For this to work a browser that supports
     783# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
     784# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
     785
     786HTML_DYNAMIC_SECTIONS  = NO
    552787
    553788# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
    554789# be used to specify the file name of the resulting .chm file. You
    555790# can add a path in front of the file if the result should not be
    556 # written to the html output dir.
     791# written to the html output directory.
    557792
    558793CHM_FILE               =
     
    689924
    690925# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
    691 # The RTF output is optimised for Word 97 and may not look very pretty with
     926# The RTF output is optimized for Word 97 and may not look very pretty with
    692927# other RTF readers or editors.
    693928
     
    716951
    717952# Load stylesheet definitions from file. Syntax is similar to doxygen's
    718 # config file, i.e. a series of assigments. You only have to provide
     953# config file, i.e. a series of assignments. You only have to provide
    719954# replacements, missing definitions are set to their default value.
    720955
     
    760995# If the GENERATE_XML tag is set to YES Doxygen will
    761996# generate an XML file that captures the structure of
    762 # the code including all documentation. Note that this
    763 # feature is still experimental and incomplete at the
    764 # moment.
     997# the code including all documentation.
    765998
    766999GENERATE_XML           = NO
     
    7831016
    7841017XML_DTD                =
     1018
     1019# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
     1020# dump the program listings (including syntax highlighting
     1021# and cross-referencing information) to the XML output. Note that
     1022# enabling this will significantly increase the size of the XML output.
     1023
     1024XML_PROGRAMLISTING     = YES
    7851025
    7861026#---------------------------------------------------------------------------
     
    8481088# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
    8491089# then the macro expansion is limited to the macros specified with the
    850 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
     1090# PREDEFINED and EXPAND_AS_DEFINED tags.
    8511091
    8521092EXPAND_ONLY_PREDEF     = NO
     
    8741114# gcc). The argument of the tag is a list of macros of the form: name
    8751115# or name=definition (no spaces). If the definition and the = are
    876 # omitted =1 is assumed.
     1116# omitted =1 is assumed. To prevent a macro definition from being
     1117# undefined via #undef or recursively expanded use the := operator
     1118# instead of the = operator.
    8771119
    8781120PREDEFINED             = FALSE=0 \
    879    CPU_USE_GENERIC_BITFIELD_DATA=0
     1121                         CPU_USE_GENERIC_BITFIELD_DATA=0
    8801122
    8811123# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
     
    8891131# doxygen's preprocessor will remove all function-like macros that are alone
    8901132# on a line, have an all uppercase name, and do not end with a semicolon. Such
    891 # function macros are typically used for boiler-plate code, and will confuse the
    892 # parser if not removed.
     1133# function macros are typically used for boiler-plate code, and will confuse
     1134# the parser if not removed.
    8931135
    8941136SKIP_FUNCTION_MACROS   = YES
    8951137
    8961138#---------------------------------------------------------------------------
    897 # Configuration::addtions related to external references   
     1139# Configuration::additions related to external references   
    8981140#---------------------------------------------------------------------------
    8991141
     
    9421184
    9431185# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
    944 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
    945 # super classes. Setting the tag to NO turns the diagrams off. Note that this
    946 # option is superceded by the HAVE_DOT option below. This is only a fallback. It is
    947 # recommended to install and use dot, since it yields more powerful graphs.
     1186# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
     1187# or super classes. Setting the tag to NO turns the diagrams off. Note that
     1188# this option is superseded by the HAVE_DOT option below. This is only a
     1189# fallback. It is recommended to install and use dot, since it yields more
     1190# powerful graphs.
    9481191
    9491192CLASS_DIAGRAMS         = YES
     1193
     1194# You can define message sequence charts within doxygen comments using the \msc
     1195# command. Doxygen will then run the mscgen tool (see
     1196# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
     1197# documentation. The MSCGEN_PATH tag allows you to specify the directory where
     1198# the mscgen tool resides. If left empty the tool is assumed to be found in the
     1199# default search path.
     1200
     1201MSCGEN_PATH            =
    9501202
    9511203# If set to YES, the inheritance and collaboration graphs will hide
     
    9761228COLLABORATION_GRAPH    = YES
    9771229
     1230# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
     1231# will generate a graph for groups, showing the direct groups dependencies
     1232
     1233GROUP_GRAPHS           = YES
     1234
    9781235# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
    979 # collaboration diagrams in a style similiar to the OMG's Unified Modeling
     1236# collaboration diagrams in a style similar to the OMG's Unified Modeling
    9801237# Language.
    9811238
     
    10011258INCLUDED_BY_GRAPH      = YES
    10021259
    1003 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
    1004 # generate a call dependency graph for every global function or class method.
    1005 # Note that enabling this option will significantly increase the time of a run.
    1006 # So in most cases it will be better to enable call graphs for selected
    1007 # functions only using the \callgraph command.
     1260# If the CALL_GRAPH and HAVE_DOT options are set to YES then
     1261# doxygen will generate a call dependency graph for every global function
     1262# or class method. Note that enabling this option will significantly increase
     1263# the time of a run. So in most cases it will be better to enable call graphs
     1264# for selected functions only using the \callgraph command.
    10081265
    10091266CALL_GRAPH             = NO
     1267
     1268# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
     1269# doxygen will generate a caller dependency graph for every global function
     1270# or class method. Note that enabling this option will significantly increase
     1271# the time of a run. So in most cases it will be better to enable caller
     1272# graphs for selected functions only using the \callergraph command.
     1273
     1274CALLER_GRAPH           = NO
    10101275
    10111276# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
     
    10131278
    10141279GRAPHICAL_HIERARCHY    = YES
     1280
     1281# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
     1282# then doxygen will show the dependencies a directory has on other directories
     1283# in a graphical way. The dependency relations are determined by the #include
     1284# relations between the files in the directories.
     1285
     1286DIRECTORY_GRAPH        = YES
    10151287
    10161288# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
     
    10211293
    10221294# The tag DOT_PATH can be used to specify the path where the dot tool can be
    1023 # found. If left blank, it is assumed the dot tool can be found on the path.
     1295# found. If left blank, it is assumed the dot tool can be found in the path.
    10241296
    10251297DOT_PATH               =
     
    10311303DOTFILE_DIRS           =
    10321304
    1033 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
    1034 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
    1035 # this value, doxygen will try to truncate the graph, so that it fits within
    1036 # the specified constraint. Beware that most browsers cannot cope with very
    1037 # large images.
    1038 
    1039 MAX_DOT_GRAPH_WIDTH    = 1024
    1040 
    1041 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
    1042 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
    1043 # this value, doxygen will try to truncate the graph, so that it fits within
    1044 # the specified constraint. Beware that most browsers cannot cope with very
    1045 # large images.
    1046 
    1047 MAX_DOT_GRAPH_HEIGHT   = 1024
     1305# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
     1306# nodes that will be shown in the graph. If the number of nodes in a graph
     1307# becomes larger than this value, doxygen will truncate the graph, which is
     1308# visualized by representing a node as a red box. Note that doxygen if the
     1309# number of direct children of the root node in a graph is already larger than
     1310# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
     1311# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
     1312
     1313DOT_GRAPH_MAX_NODES    = 50
    10481314
    10491315# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
    10501316# graphs generated by dot. A depth value of 3 means that only nodes reachable
    1051 # from the root by following a path via at most 3 edges will be shown. Nodes that
    1052 # lay further from the root node will be omitted. Note that setting this option to
    1053 # 1 or 2 may greatly reduce the computation time needed for large code bases. Also
    1054 # note that a graph may be further truncated if the graph's image dimensions are
    1055 # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
    1056 # If 0 is used for the depth value (the default), the graph is not depth-constrained.
     1317# from the root by following a path via at most 3 edges will be shown. Nodes
     1318# that lay further from the root node will be omitted. Note that setting this
     1319# option to 1 or 2 may greatly reduce the computation time needed for large
     1320# code bases. Also note that the size of a graph can be further restricted by
     1321# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
    10571322
    10581323MAX_DOT_GRAPH_DEPTH    = 0
     1324
     1325# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
     1326# background. This is enabled by default, which results in a transparent
     1327# background. Warning: Depending on the platform used, enabling this option
     1328# may lead to badly anti-aliased labels on the edges of a graph (i.e. they
     1329# become hard to read).
     1330
     1331DOT_TRANSPARENT        = YES
     1332
     1333# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
     1334# files in one run (i.e. multiple -o and -T options on the command line). This
     1335# makes dot run faster, but since only newer versions of dot (>1.8.10)
     1336# support this, this feature is disabled by default.
     1337
     1338DOT_MULTI_TARGETS      = NO
    10591339
    10601340# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
     
    10711351
    10721352#---------------------------------------------------------------------------
    1073 # Configuration::addtions related to the search engine   
     1353# Configuration::additions related to the search engine   
    10741354#---------------------------------------------------------------------------
    10751355
  • cpukit/rtems/include/rtems/rtems/asr.h

    r067a96a rf9293df  
    77 */
    88
    9 /*  COPYRIGHT (c) 1989-1999.
     9/*  COPYRIGHT (c) 1989-2008.
    1010 *  On-Line Applications Research Corporation (OAR).
    1111 *
     
    5757 */
    5858typedef struct {
    59   boolean           is_enabled;       /* are ASRs enabled currently? */
    60   rtems_asr_entry   handler;          /* address of RTEMS_ASR */
    61   Modes_Control     mode_set;         /* RTEMS_ASR mode */
    62   rtems_signal_set  signals_posted;   /* signal set */
    63   rtems_signal_set  signals_pending;  /* pending signal set */
    64   uint32_t          nest_level;       /* nest level of RTEMS_ASR */
     59  /** This field indicates if are ASRs enabled currently. */
     60  boolean           is_enabled;
     61  /** This field indicates if address of the signal handler function. */
     62  rtems_asr_entry   handler;
     63  /** This field indicates if the task mode the signal will run with. */
     64  Modes_Control     mode_set;
     65  /** This field indicates the signal set that is posted. */
     66  rtems_signal_set  signals_posted;
     67  /** This field indicates the signal set that is pending. */
     68  rtems_signal_set  signals_pending;
     69  /** This field indicates if nest level of signals being processed */
     70  uint32_t          nest_level;
    6571}   ASR_Information;
    6672
  • cpukit/rtems/include/rtems/rtems/attr.h

    r067a96a rf9293df  
    66 */
    77
    8 /*  COPYRIGHT (c) 1989-1999.
     8/*  COPYRIGHT (c) 1989-2008.
    99 *  On-Line Applications Research Corporation (OAR).
    1010 *
     
    3030/**@{*/
    3131
    32 /* types */
    33 
     32/**
     33 *  This defines the type used to contain Classic API attributes.  These
     34 *  are primarily used when creating objects.
     35 */
    3436typedef uint32_t   rtems_attribute;
    3537
    36 /* constants */
     38/** This is the default value for an attribute set. */
    3739
    3840#define RTEMS_DEFAULT_ATTRIBUTES  0x00000000
    3941
    40 #define RTEMS_LOCAL               0x00000000 /* local resource */
    41 #define RTEMS_GLOBAL              0x00000002 /* global resource */
    42 
    43 #define RTEMS_FIFO                0x00000000 /* process RTEMS_FIFO */
    44 #define RTEMS_PRIORITY            0x00000004 /* process by priority */
    45 
    46         /* RTEMS Task Specific Attributes */
    47 #define RTEMS_NO_FLOATING_POINT   0x00000000 /* don't use FP HW */
    48 #define RTEMS_FLOATING_POINT      0x00000001 /* utilize coprocessor */
    49 
    50         /* RTEMS Semaphore Specific Attributes */
    51 #define RTEMS_SEMAPHORE_CLASS         0x00000030 /* mask */
     42/**
     43 *  This is the attribute constant to indicate local resource.
     44 */
     45#define RTEMS_LOCAL               0x00000000
     46
     47/**
     48 *  This is the attribute constant to indicate global resource.
     49 */
     50#define RTEMS_GLOBAL              0x00000002
     51
     52/**
     53 *  This is the attribute constant which reflects that blocking
     54 *  tasks will be managed using FIFO discipline.
     55 */
     56#define RTEMS_FIFO                0x00000000
     57
     58/**
     59 *  This is the attribute constant which reflects that blocking
     60 *  tasks will be managed using task priority discipline.
     61 */
     62#define RTEMS_PRIORITY            0x00000004
     63
     64/******************** RTEMS Task Specific Attributes *********************/
     65
     66/**
     67 *  This attribute constant indicates that the task will not use the
     68 *  floating point hardware.  If the architecture permits it, then
     69 *  the FPU will be disabled when the task is executing.
     70 */
     71#define RTEMS_NO_FLOATING_POINT   0x00000000
     72
     73/**
     74 *  This attribute constant indicates that the task will use the
     75 *  floating point hardware.  There will be a floating point
     76 *  context associated with this task.
     77 */
     78#define RTEMS_FLOATING_POINT      0x00000001
     79
     80/***************** RTEMS Semaphore Specific Attributes ********************/
     81
     82/**
     83 *  This is the mask for the attribute bits associated with the
     84 *  Classic API Semaphore Manager.
     85 */
     86#define RTEMS_SEMAPHORE_CLASS         0x00000030
     87
     88/**
     89 *  This attribute constant indicates that the Classic API Semaphore
     90 *  instance created will be a counting semaphore.
     91 */
    5292#define RTEMS_COUNTING_SEMAPHORE      0x00000000
     93
     94/**
     95 *  This attribute constant indicates that the Classic API Semaphore
     96 *  instance created will be a proper binary semaphore or mutex.
     97 */
    5398#define RTEMS_BINARY_SEMAPHORE        0x00000010
     99
     100/**
     101 *  This attribute constant indicates that the Classic API Semaphore
     102 *  instance created will be a simple binary semaphore.
     103 */
    54104#define RTEMS_SIMPLE_BINARY_SEMAPHORE 0x00000020
    55105
     106/**
     107 *  This attribute constant indicates that the Classic API Semaphore
     108 *  instance created will NOT use the Priority Inheritance Protocol.
     109 */
    56110#define RTEMS_NO_INHERIT_PRIORITY     0x00000000
     111
     112/**
     113 *  This attribute constant indicates that the Classic API Semaphore
     114 *  instance created will use the Priority Inheritance Protocol.
     115 *
     116 *  @note The semaphore instance must be a binary semaphore.
     117 */
    57118#define RTEMS_INHERIT_PRIORITY        0x00000040
    58119
     120/**
     121 *  This attribute constant indicates that the Classic API Semaphore
     122 *  instance created will NOT use the Priority Ceiling Protocol.
     123 */
    59124#define RTEMS_NO_PRIORITY_CEILING     0x00000000
     125
     126/**
     127 *  This attribute constant indicates that the Classic API Semaphore
     128 *  instance created will use the Priority Ceiling Protocol.
     129 *
     130 *  @note The semaphore instance must be a binary semaphore.
     131 */
    60132#define RTEMS_PRIORITY_CEILING        0x00000080
    61133
    62         /* RTEMS Barrier Specific Attributes */
     134/******************** RTEMS Barrier Specific Attributes ********************/
     135
     136/**
     137 *  This attribute constant indicates that the Classic API Barrier
     138 *  instance created will use an automatic release protocol.
     139 */
    63140#define RTEMS_BARRIER_AUTOMATIC_RELEASE 0x00000010
     141
     142/**
     143 *  This attribute constant indicates that the Classic API Barrier
     144 *  instance created will use the manual release protocol.
     145 */
    64146#define RTEMS_BARRIER_MANUAL_RELEASE    0x00000000
    65147
    66         /* RTEMS Internal Task Specific Attributes */
     148/**************** RTEMS Internal Task Specific Attributes ****************/
     149
     150/**
     151 *  This attribute constant indicates that the task was created
     152 *  by the application using normal Classic API methods.
     153 */
    67154#define RTEMS_APPLICATION_TASK        0x00000000
     155
     156/**
     157 *  This attribute constant indicates that the task was created
     158 *  by RTEMS as a support task.
     159 */
    68160#define RTEMS_SYSTEM_TASK             0x00008000
    69161
    70 
     162/****************** Forced Attributes in Configuration ****************/
     163
     164/**
     165 *  This attribute constant indicates the attributes that are not
     166 *  supportable given the hardware configuration.
     167 */
    71168#if ( CPU_HARDWARE_FP == TRUE ) || ( CPU_SOFTWARE_FP == TRUE )
    72169#define ATTRIBUTES_NOT_SUPPORTED       0
     
    75172#endif
    76173
     174/**
     175 *  This attribute constant indicates the attributes that are
     176 *  required given the hardware configuration.
     177 */
    77178#if ( CPU_ALL_TASKS_ARE_FP == TRUE )
    78179#define ATTRIBUTES_REQUIRED            RTEMS_FLOATING_POINT
  • cpukit/rtems/include/rtems/rtems/barrier.h

    r067a96a rf9293df  
    1414 */
    1515
    16 /*  COPYRIGHT (c) 1989-2007.
     16/*  COPYRIGHT (c) 1989-2008.
    1717 *  On-Line Applications Research Corporation (OAR).
    1818 *
     
    3434/**@{*/
    3535
     36/**
     37 *  This constant is defined to extern most of the time when using
     38 *  this header file.  However by defining it to nothing, the data
     39 *  declared in this header file can be instantiated.  This is done
     40 *  in a single per manager file.
     41 */
    3642#ifndef RTEMS_BARRIER_EXTERN
    3743#define RTEMS_BARRIER_EXTERN extern
  • cpukit/rtems/include/rtems/rtems/barriermp.h

    r067a96a rf9293df  
    66 */
    77
    8 /*  COPYRIGHT (c) 1989-2006.
     8/*  COPYRIGHT (c) 1989-2008.
    99 *  On-Line Applications Research Corporation (OAR).
    1010 *
  • cpukit/rtems/include/rtems/rtems/cache.h

    r067a96a rf9293df  
    55 */
    66
    7 /*  COPYRIGHT (c) 1989-1999.
     7/*  COPYRIGHT (c) 1989-2008.
    88 *  On-Line Applications Research Corporation (OAR).
    99 *
  • cpukit/rtems/include/rtems/rtems/config.h

    r067a96a rf9293df  
    66 */
    77
    8 /*  COPYRIGHT (c) 1989-2006.
     8/*  COPYRIGHT (c) 1989-2008.
    99 *  On-Line Applications Research Corporation (OAR).
    1010 *
  • cpukit/rtems/include/rtems/rtems/dpmem.h

    r067a96a rf9293df  
    1717 */
    1818
    19 /*  COPYRIGHT (c) 1989-2007.
     19/*  COPYRIGHT (c) 1989-2008.
    2020 *  On-Line Applications Research Corporation (OAR).
    2121 *
     
    3030#define _RTEMS_RTEMS_DPMEM_H
    3131
     32/**
     33 *  This constant is defined to extern most of the time when using
     34 *  this header file.  However by defining it to nothing, the data
     35 *  declared in this header file can be instantiated.  This is done
     36 *  in a single per manager file.
     37 */
    3238#ifndef RTEMS_DPMEM_EXTERN
    3339#define RTEMS_DPMEM_EXTERN extern
  • cpukit/rtems/include/rtems/rtems/event.h

    r067a96a rf9293df  
    2626#define _RTEMS_RTEMS_EVENT_H
    2727
     28/**
     29 *  This constant is defined to extern most of the time when using
     30 *  this header file.  However by defining it to nothing, the data
     31 *  declared in this header file can be instantiated.  This is done
     32 *  in a single per manager file.
     33 */
    2834#ifndef RTEMS_EVENT_EXTERN
    2935#define RTEMS_EVENT_EXTERN extern
  • cpukit/rtems/include/rtems/rtems/eventmp.h

    r067a96a rf9293df  
    66 */
    77
    8 /*  COPYRIGHT (c) 1989-1999.
     8/*  COPYRIGHT (c) 1989-2008.
    99 *  On-Line Applications Research Corporation (OAR).
    1010 *
  • cpukit/rtems/include/rtems/rtems/eventset.h

    r067a96a rf9293df  
    77 */
    88
    9 /*  COPYRIGHT (c) 1989-1999.
     9/*  COPYRIGHT (c) 1989-2008.
    1010 *  On-Line Applications Research Corporation (OAR).
    1111 *
     
    3737
    3838/**
    39  *  The following constants define the individual events which may
    40  *  be used to compose an event set.
     39 *  The following constant is used to receive the set of currently pending
     40 *  events.
    4141 */
    42 #define RTEMS_PENDING_EVENTS      0           /* receive pending events   */
     42#define RTEMS_PENDING_EVENTS      0
     43
     44/**
     45 *  The following constant is used when you wish to send or receive all
     46 *  events.
     47 */
    4348#define RTEMS_ALL_EVENTS  0xFFFFFFFF
    4449
  • cpukit/rtems/include/rtems/rtems/intr.h

    r067a96a rf9293df  
    66 */
    77
    8 /*  COPYRIGHT (c) 1989-1999.
     8/*  COPYRIGHT (c) 1989-2008.
    99 *  On-Line Applications Research Corporation (OAR).
    1010 *
  • cpukit/rtems/include/rtems/rtems/message.h

    r067a96a rf9293df  
    1818 */
    1919
    20 /*  COPYRIGHT (c) 1989-2007.
     20/*  COPYRIGHT (c) 1989-2008.
    2121 *  On-Line Applications Research Corporation (OAR).
    2222 *
     
    3131#define _RTEMS_RTEMS_MESSAGE_H
    3232
     33/**
     34 *  This constant is defined to extern most of the time when using
     35 *  this header file.  However by defining it to nothing, the data
     36 *  declared in this header file can be instantiated.  This is done
     37 *  in a single per manager file.
     38 */
    3339#ifndef RTEMS_MESSAGE_EXTERN
    3440#define RTEMS_MESSAGE_EXTERN extern
     
    5359/**@{*/
    5460
    55 /*
     61/**
    5662 *  The following enumerated type details the modes in which a message
    5763 *  may be submitted to a message queue.  The message may be posted
     
    5965 */
    6066typedef enum {
     67  /**
     68   *  This value indicates the user wants to send the message using the
     69   *  normal message insertion protocol (FIFO or priority).
     70   */
    6171  MESSAGE_QUEUE_SEND_REQUEST   = 0,
     72  /**
     73   *  This value indicates the user considers the message to be urgent
     74   *  and wants it inserted at the head of the pending message queue.
     75   */
    6276  MESSAGE_QUEUE_URGENT_REQUEST = 1
    6377}  Message_queue_Submit_types;
     
    6882 */
    6983typedef struct {
     84  /** This field is the inherited obejct characteristics. */
    7085  Objects_Control             Object;
     86  /** This field is the attribute set as defined by the API. */
    7187  rtems_attribute             attribute_set;
     88  /** This field is the instance of the SuperCore Message Queue. */
    7289  CORE_message_queue_Control  message_queue;
    7390}   Message_queue_Control;
    7491
    75 /*
     92/**
    7693 *  The following defines the information control block used to
    7794 *  manage this class of objects.
     
    293310#endif
    294311
     312/**@}*/
     313
    295314#endif
    296315/* end of include file */
  • cpukit/rtems/include/rtems/rtems/modes.h

    r067a96a rf9293df  
    66 */
    77
    8 /*  COPYRIGHT (c) 1989-1999.
     8/*  COPYRIGHT (c) 1989-2008.
    99 *  On-Line Applications Research Corporation (OAR).
    1010 *
     
    4444#define RTEMS_ALL_MODE_MASKS     0x0000ffff
    4545
     46/**
     47 *  This mode constant is the default mode set.
     48 */
    4649#define RTEMS_DEFAULT_MODES     0x00000000
     50
     51/**
     52 *  This mode constant is used when the user wishes to obtain their
     53 *  current execution mode.
     54 */
    4755#define RTEMS_CURRENT_MODE      0
     56 
     57/** This mode constant corresponds to the timeslice enable/disable bit. */
     58#define RTEMS_TIMESLICE_MASK  0x00000200
    4859
    49 #define RTEMS_PREEMPT_MASK    0x00000100  /* preemption bit           */
    50 #define RTEMS_TIMESLICE_MASK  0x00000200  /* timeslice bit            */
    51 #define RTEMS_ASR_MASK        0x00000400  /* RTEMS_ASR enable bit           */
     60/** This mode constant corresponds to the preemption enable/disable bit. */
     61#define RTEMS_PREEMPT_MASK    0x00000100
     62
     63/** This mode constant corresponds to the signal enable/disable bit. */
     64#define RTEMS_ASR_MASK        0x00000400
     65
     66/** This mode constant corresponds to the interrupt enable/disable bits. */
    5267#define RTEMS_INTERRUPT_MASK  CPU_MODES_INTERRUPT_MASK
    5368
    54 #define RTEMS_PREEMPT      0x00000000     /* enable preemption        */
    55 #define RTEMS_NO_PREEMPT   0x00000100     /* disable preemption       */
     69/** This mode constant is used to indicate preemption is enabled. */
     70#define RTEMS_PREEMPT      0x00000000
     71/** This mode constant is used to indicate preemption is disabled. */
     72#define RTEMS_NO_PREEMPT   0x00000100
    5673
    57 #define RTEMS_NO_TIMESLICE 0x00000000     /* disable timeslicing      */
    58 #define RTEMS_TIMESLICE    0x00000200     /* enable timeslicing       */
     74/** This mode constant is used to indicate timeslicing is disabled. */
     75#define RTEMS_NO_TIMESLICE 0x00000000
     76/** This mode constant is used to indicate timeslicing is enabled. */
     77#define RTEMS_TIMESLICE    0x00000200
    5978
    60 #define RTEMS_ASR          0x00000000     /* enable RTEMS_ASR               */
    61 #define RTEMS_NO_ASR       0x00000400     /* disable RTEMS_ASR              */
    62 
    63 /**
    64  *  The number of bits for interrupt levels is CPU dependent.
    65  *  RTEMS supports 0 to 256 levels in bits 0-7 of the mode.
    66  */
     79/** This mode constant is used to indicate signal processing is enabled. */
     80#define RTEMS_ASR          0x00000000
     81/** This mode constant is used to indicate signal processing is disabled. */
     82#define RTEMS_NO_ASR       0x00000400
    6783
    6884/**
     
    88104#endif
    89105
     106/**@}*/
     107
    90108#endif
    91109/* end of include file */
  • cpukit/rtems/include/rtems/rtems/mp.h

    r067a96a rf9293df  
    66 */
    77
    8 /*  COPYRIGHT (c) 1989-1999.
     8/*  COPYRIGHT (c) 1989-2008.
    99 *  On-Line Applications Research Corporation (OAR).
    1010 *
  • cpukit/rtems/include/rtems/rtems/msgmp.h

    r067a96a rf9293df  
    66 */
    77
    8 /*  COPYRIGHT (c) 1989-1999.
     8/*  COPYRIGHT (c) 1989-2008.
    99 *  On-Line Applications Research Corporation (OAR).
    1010 *
  • cpukit/rtems/include/rtems/rtems/options.h

    r067a96a rf9293df  
    66 */
    77
    8 /*  COPYRIGHT (c) 1989-1999.
     8/*  COPYRIGHT (c) 1989-2008.
    99 *  On-Line Applications Research Corporation (OAR).
    1010 *
     
    4242#define RTEMS_DEFAULT_OPTIONS   0x00000000
    4343
    44 #define RTEMS_WAIT      0x00000000        /* wait on resource */
    45 #define RTEMS_NO_WAIT   0x00000001        /* do not wait on resource */
     44/**
     45 *  This option constants indicates that the task is to wait on resource.
     46 */
     47#define RTEMS_WAIT      0x00000000
     48/**
     49 *  This option constants indicates that the task is to not wait on
     50 *  the resource.  If it is not available, return immediately with
     51 *  a status to indicate unsatisfied.
     52 */
     53#define RTEMS_NO_WAIT   0x00000001
    4654
    47 #define RTEMS_EVENT_ALL 0x00000000        /* wait for all events */
    48 #define RTEMS_EVENT_ANY 0x00000002        /* wait on any event */
     55/**
     56 *  This option constants indicates that the task wishes to wait until
     57 *  all events of interest are available.
     58 */
     59#define RTEMS_EVENT_ALL 0x00000000
     60
     61/**
     62 *  This option constants indicates that the task wishes to wait until
     63 *  ANY events of interest are available.
     64 */
     65#define RTEMS_EVENT_ANY 0x00000002
    4966
    5067#ifndef __RTEMS_APPLICATION__
     
    5673#endif
    5774
     75/**@}*/
     76
    5877#endif
    5978/* end of include file */
  • cpukit/rtems/include/rtems/rtems/part.h

    r067a96a rf9293df  
    1616 */
    1717
    18 /*  COPYRIGHT (c) 1989-2007.
     18/*  COPYRIGHT (c) 1989-2008.
    1919 *  On-Line Applications Research Corporation (OAR).
    2020 *
     
    2929#define _RTEMS_RTEMS_PART_H
    3030
     31/**
     32 *  This constant is defined to extern most of the time when using
     33 *  this header file.  However by defining it to nothing, the data
     34 *  declared in this header file can be instantiated.  This is done
     35 *  in a single per manager file.
     36 */
    3137#ifndef RTEMS_PART_EXTERN
    3238#define RTEMS_PART_EXTERN extern
  • cpukit/rtems/include/rtems/rtems/partmp.h

    r067a96a rf9293df  
    66 */
    77
    8 /*  COPYRIGHT (c) 1989-1999.
     8/*  COPYRIGHT (c) 1989-2008.
    99 *  On-Line Applications Research Corporation (OAR).
    1010 *
  • cpukit/rtems/include/rtems/rtems/ratemon.h

    r067a96a rf9293df  
    1515 */
    1616
    17 /*  COPYRIGHT (c) 1989-2007.
     17/*  COPYRIGHT (c) 1989-2008.
    1818 *  On-Line Applications Research Corporation (OAR).
    1919 *
     
    2828#define _RTEMS_RTEMS_RATEMON_H
    2929
     30/**
     31 *  This constant is defined to extern most of the time when using
     32 *  this header file.  However by defining it to nothing, the data
     33 *  declared in this header file can be instantiated.  This is done
     34 *  in a single per manager file.
     35 */
    3036#ifndef RTEMS_RATEMON_EXTERN
    3137#define RTEMS_RATEMON_EXTERN extern
  • cpukit/rtems/include/rtems/rtems/region.h

    r067a96a rf9293df  
    1515 */
    1616
    17 /*  COPYRIGHT (c) 1989-2007.
     17/*  COPYRIGHT (c) 1989-2008.
    1818 *  On-Line Applications Research Corporation (OAR).
    1919 *
     
    4747/**@{*/
    4848
     49/**
     50 *  This constant is defined to extern most of the time when using
     51 *  this header file.  However by defining it to nothing, the data
     52 *  declared in this header file can be instantiated.  This is done
     53 *  in a single per manager file.
     54 */
    4955#ifndef RTEMS_REGION_EXTERN
    5056#define RTEMS_REGION_EXTERN extern
  • cpukit/rtems/include/rtems/rtems/regionmp.h

    r067a96a rf9293df  
    66 */
    77
    8 /*  COPYRIGHT (c) 1989-1999.
     8/*  COPYRIGHT (c) 1989-2008.
    99 *  On-Line Applications Research Corporation (OAR).
    1010 *
  • cpukit/rtems/include/rtems/rtems/rtemsapi.h

    r067a96a rf9293df  
    55 */
    66
    7 /*  COPYRIGHT (c) 1989-1999.
     7/*  COPYRIGHT (c) 1989-2008.
    88 *  On-Line Applications Research Corporation (OAR).
    99 *
     
    2121
    2222/**
    23  *  @defgroup ClassicRTEMS Classic RTEMS Support
    24  *
    25  *  This encapsulates functionality which XXX
     23 *  @addtogroup ClassicRTEMS
     24 *  @{
    2625 */
    27 /**@{*/
    2826
    2927/**
  • cpukit/rtems/include/rtems/rtems/sem.h

    r067a96a rf9293df  
    1616 */
    1717
    18 /*  COPYRIGHT (c) 1989-2007.
     18/*  COPYRIGHT (c) 1989-2008.
    1919 *  On-Line Applications Research Corporation (OAR).
    2020 *
     
    2929#define _RTEMS_RTEMS_SEM_H
    3030
     31/**
     32 *  This constant is defined to extern most of the time when using
     33 *  this header file.  However by defining it to nothing, the data
     34 *  declared in this header file can be instantiated.  This is done
     35 *  in a single per manager file.
     36 */
    3137#ifndef RTEMS_SEM_EXTERN
    3238#define RTEMS_SEM_EXTERN extern
  • cpukit/rtems/include/rtems/rtems/semmp.h

    r067a96a rf9293df  
    66 */
    77
    8 /*  COPYRIGHT (c) 1989-1999.
     8/*  COPYRIGHT (c) 1989-2008.
    99 *  On-Line Applications Research Corporation (OAR).
    1010 *
     
    168168#endif
    169169
     170/**@}*/
     171
    170172#endif
    171173/* end of file */
  • cpukit/rtems/include/rtems/rtems/signal.h

    r067a96a rf9293df  
    1212 */
    1313
    14 /*  COPYRIGHT (c) 1989-1999.
     14/*  COPYRIGHT (c) 1989-2008.
    1515 *  On-Line Applications Research Corporation (OAR).
    1616 *
  • cpukit/rtems/include/rtems/rtems/signalmp.h

    r067a96a rf9293df  
    66 */
    77
    8 /*  COPYRIGHT (c) 1989-1999.
     8/*  COPYRIGHT (c) 1989-2008.
    99 *  On-Line Applications Research Corporation (OAR).
    1010 *
  • cpukit/rtems/include/rtems/rtems/status.h

    r067a96a rf9293df  
    66 */
    77
    8 /*  COPYRIGHT (c) 1989-1999.
     8/*  COPYRIGHT (c) 1989-2008.
    99 *  On-Line Applications Research Corporation (OAR).
    1010 *
  • cpukit/rtems/include/rtems/rtems/support.h

    r067a96a rf9293df  
    2626
    2727/**
    28  *  @defgroup ClassicSupport Classic API Support
    29  *
    30  *  This encapsulates functionality which XXX
     28 *  @addtogroup ClassicRTEMS
     29 *  @{
    3130 */
    32 /**@{*/
    3331
    3432/**
  • cpukit/rtems/include/rtems/rtems/taskmp.h

    r067a96a rf9293df  
    66 */
    77
    8 /*  COPYRIGHT (c) 1989-1999.
     8/*  COPYRIGHT (c) 1989-2008.
    99 *  On-Line Applications Research Corporation (OAR).
    1010 *
  • cpukit/rtems/include/rtems/rtems/tasks.h

    r067a96a rf9293df  
    2323 */
    2424
    25 /*  COPYRIGHT (c) 1989-2007.
     25/*  COPYRIGHT (c) 1989-2008.
    2626 *  On-Line Applications Research Corporation (OAR).
    2727 *
     
    4545#include <rtems/rtems/status.h>
    4646
     47/**
     48 *  This constant is defined to extern most of the time when using
     49 *  this header file.  However by defining it to nothing, the data
     50 *  declared in this header file can be instantiated.  This is done
     51 *  in a single per manager file.
     52 */
    4753#ifndef RTEMS_TASKS_EXTERN
    4854#define RTEMS_TASKS_EXTERN extern
  • cpukit/rtems/include/rtems/rtems/timer.h

    r067a96a rf9293df  
    2323 */
    2424
    25 /*  COPYRIGHT (c) 1989-2007.
     25/*  COPYRIGHT (c) 1989-2008.
    2626 *  On-Line Applications Research Corporation (OAR).
    2727 *
     
    3636#define _RTEMS_RTEMS_TIMER_H
    3737
     38/**
     39 *  This constant is defined to extern most of the time when using
     40 *  this header file.  However by defining it to nothing, the data
     41 *  declared in this header file can be instantiated.  This is done
     42 *  in a single per manager file.
     43 */
    3844#ifndef RTEMS_TIMER_EXTERN
    3945#define RTEMS_TIMER_EXTERN extern
  • cpukit/rtems/include/rtems/rtems/types.h

    r067a96a rf9293df  
    55 */
    66
    7 /*  COPYRIGHT (c) 1989-1999.
     7/*  COPYRIGHT (c) 1989-2008.
    88 *  On-Line Applications Research Corporation (OAR).
    99 *
  • cpukit/rtems/inline/rtems/rtems/asr.inl

    r067a96a rf9293df  
    66 */
    77
    8 /*  COPYRIGHT (c) 1989-1999.
     8/*  COPYRIGHT (c) 1989-2008.
    99 *  On-Line Applications Research Corporation (OAR).
    1010 *
  • cpukit/rtems/inline/rtems/rtems/attr.inl

    r067a96a rf9293df  
    77
    88/*
    9  *  COPYRIGHT (c) 1989-1999.
     9 *  COPYRIGHT (c) 1989-2008.
    1010 *  On-Line Applications Research Corporation (OAR).
    1111 *
  • cpukit/rtems/inline/rtems/rtems/barrier.inl

    r067a96a rf9293df  
    66 */
    77
    8 /*  COPYRIGHT (c) 1989-2006.
     8/*  COPYRIGHT (c) 1989-2008.
    99 *  On-Line Applications Research Corporation (OAR).
    1010 *
  • cpukit/rtems/inline/rtems/rtems/dpmem.inl

    r067a96a rf9293df  
    66 */
    77
    8 /*  COPYRIGHT (c) 1989-1999.
     8/*  COPYRIGHT (c) 1989-2008.
    99 *  On-Line Applications Research Corporation (OAR).
    1010 *
  • cpukit/rtems/inline/rtems/rtems/event.inl

    r067a96a rf9293df  
    66 */
    77
    8 /*  COPYRIGHT (c) 1989-1999.
     8/*  COPYRIGHT (c) 1989-2008.
    99 *  On-Line Applications Research Corporation (OAR).
    1010 *
  • cpukit/rtems/inline/rtems/rtems/message.inl

    r067a96a rf9293df  
    66 */
    77
    8 /*  COPYRIGHT (c) 1989-1999.
     8/*  COPYRIGHT (c) 1989-2008.
    99 *  On-Line Applications Research Corporation (OAR).
    1010 *
  • cpukit/rtems/inline/rtems/rtems/modes.inl

    r067a96a rf9293df  
    66 */
    77
    8 /*  COPYRIGHT (c) 1989-1999.
     8/*  COPYRIGHT (c) 1989-2008.
    99 *  On-Line Applications Research Corporation (OAR).
    1010 *
  • cpukit/rtems/inline/rtems/rtems/options.inl

    r067a96a rf9293df  
    66 */
    77
    8 /*  COPYRIGHT (c) 1989-1999.
     8/*  COPYRIGHT (c) 1989-2008.
    99 *  On-Line Applications Research Corporation (OAR).
    1010 *
  • cpukit/rtems/inline/rtems/rtems/part.inl

    r067a96a rf9293df  
    66 */
    77
    8 /*  COPYRIGHT (c) 1989-1999.
     8/*  COPYRIGHT (c) 1989-2008.
    99 *  On-Line Applications Research Corporation (OAR).
    1010 *
  • cpukit/rtems/inline/rtems/rtems/ratemon.inl

    r067a96a rf9293df  
    66 */
    77
    8 /*  COPYRIGHT (c) 1989-2007.
     8/*  COPYRIGHT (c) 1989-2008.
    99 *  On-Line Applications Research Corporation (OAR).
    1010 *
  • cpukit/rtems/inline/rtems/rtems/region.inl

    r067a96a rf9293df  
    66 */
    77
    8 /*  COPYRIGHT (c) 1989-1999.
     8/*  COPYRIGHT (c) 1989-2008.
    99 *  On-Line Applications Research Corporation (OAR).
    1010 *
     
    106106}
    107107
     108/**@}*/
     109
    108110#endif
    109111/* end of include file */
  • cpukit/rtems/inline/rtems/rtems/sem.inl

    r067a96a rf9293df  
    66 */
    77
    8 /*  COPYRIGHT (c) 1989-1999.
     8/*  COPYRIGHT (c) 1989-2008.
    99 *  On-Line Applications Research Corporation (OAR).
    1010 *
  • cpukit/rtems/inline/rtems/rtems/status.inl

    r067a96a rf9293df  
    66 */
    77
    8 /*  COPYRIGHT (c) 1989-1999.
     8/*  COPYRIGHT (c) 1989-2008.
    99 *  On-Line Applications Research Corporation (OAR).
    1010 *
  • cpukit/rtems/inline/rtems/rtems/support.inl

    r067a96a rf9293df  
    66 */
    77
    8 /*  COPYRIGHT (c) 1989-1999.
     8/*  COPYRIGHT (c) 1989-2008.
    99 *  On-Line Applications Research Corporation (OAR).
    1010 *
  • cpukit/rtems/inline/rtems/rtems/timer.inl

    r067a96a rf9293df  
    66 */
    77
    8 /*  COPYRIGHT (c) 1989-1999.
     8/*  COPYRIGHT (c) 1989-2008.
    99 *  On-Line Applications Research Corporation (OAR).
    1010 *
Note: See TracChangeset for help on using the changeset viewer.