Changeset 18ca4e8 in rtems


Ignore:
Timestamp:
Jan 29, 2008, 11:58:17 PM (11 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, 4.9, master
Children:
87cc26db
Parents:
95e7637
Message:

2008-01-29 Joel Sherrill <joel.sherrill@…>

  • score/Doxyfile: Update to latest Doxygen format.
  • score/include/rtems/score/apimutex.h, score/include/rtems/score/corebarrier.h, score/include/rtems/score/coremutex.h, score/include/rtems/score/corerwlock.h, score/include/rtems/score/heap.h, score/include/rtems/score/object.h, score/include/rtems/score/protectedheap.h, score/include/rtems/score/thread.h, score/include/rtems/score/threadsync.h, score/include/rtems/score/tod.h, score/inline/rtems/score/corerwlock.inl, score/inline/rtems/score/corespinlock.inl: Remove most doxygen warnings.
Location:
cpukit
Files:
14 edited

Legend:

Unmodified
Added
Removed
  • cpukit/ChangeLog

    r95e7637 r18ca4e8  
     12008-01-29      Joel Sherrill <joel.sherrill@oarcorp.com>
     2
     3        * score/Doxyfile: Update to latest Doxygen format.
     4        * score/include/rtems/score/apimutex.h,
     5        score/include/rtems/score/corebarrier.h,
     6        score/include/rtems/score/coremutex.h,
     7        score/include/rtems/score/corerwlock.h,
     8        score/include/rtems/score/heap.h, score/include/rtems/score/object.h,
     9        score/include/rtems/score/protectedheap.h,
     10        score/include/rtems/score/thread.h,
     11        score/include/rtems/score/threadsync.h,
     12        score/include/rtems/score/tod.h,
     13        score/inline/rtems/score/corerwlock.inl,
     14        score/inline/rtems/score/corespinlock.inl: Remove most doxygen
     15        warnings.
     16
    1172008-01-29      Joel Sherrill <joel.sherrill@OARcorp.com>
    218
  • cpukit/score/Doxyfile

    r95e7637 r18ca4e8  
    1 # Doxyfile 1.3.4
     1# Doxyfile 1.5.4
    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 that
     18# follow. The default is UTF-8 which is also the encoding used for all text before
     19# the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into
     20# libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of
     21# 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 SuperCore
     28PROJECT_NAME           = RTEMSSuperCore
    2129
    2230# The PROJECT_NUMBER tag can be used to enter a project or revision number.
     
    3341OUTPUT_DIRECTORY       = score_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, Finnish, French, German, Greek, Hungarian,
     58# Italian, Japanese, Japanese-en (Japanese with English messages), Korean,
     59# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian,
     60# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
    4361
    4462OUTPUT_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
    5563
    5664# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
     
    6876REPEAT_BRIEF           = YES
    6977
     78# This tag implements a quasi-intelligent brief description abbreviator
     79# that is used to form the text in various listings. Each string
     80# in this list, if found as the leading text of the brief description, will be
     81# stripped from the text and the result after processing the whole list, is
     82# used as the annotated text. Otherwise, the brief description is used as-is.
     83# If left blank, the following values are used ("$name" is automatically
     84# replaced with the name of the entity): "The $name class" "The $name widget"
     85# "The $name file" "is" "provides" "specifies" "contains"
     86# "represents" "a" "an" "the"
     87
     88ABBREVIATE_BRIEF       =
     89
    7090# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
    7191# Doxygen will generate a detailed section even if there is only a brief
     
    7494ALWAYS_DETAILED_SEC    = NO
    7595
    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.
     96# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
     97# inherited members of a class in the documentation of that class as if those
     98# members were ordinary class members. Constructors, destructors and assignment
     99# operators of the base classes will not be shown.
    80100
    81101INLINE_INHERITED_MEMB  = NO
     
    90110# can be used to strip a user-defined part of the path. Stripping is
    91111# 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.
     112# the path. The tag can be used to show relative paths in the file list.
     113# If left blank the directory from which doxygen is run is used as the
     114# path to strip.
    93115
    94116STRIP_FROM_PATH        =
     117
     118# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
     119# the path mentioned in the documentation of a class, which tells
     120# the reader which header file to include in order to use a class.
     121# If left blank only the name of the header file containing the class
     122# definition is used. Otherwise one should specify the include paths that
     123# are normally passed to the compiler using the -I flag.
     124
     125STRIP_FROM_INC_PATH    =
    95126
    96127# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
     
    103134# will interpret the first line (until the first dot) of a JavaDoc-style
    104135# 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.
     136# comments will behave just like regular Qt-style comments
     137# (thus requiring an explicit @brief command for a brief description.)
    107138
    108139JAVADOC_AUTOBRIEF      = NO
     140
     141# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
     142# interpret the first line (until the first dot) of a Qt-style
     143# comment as the brief description. If set to NO, the comments
     144# will behave just like regular Qt-style comments (thus requiring
     145# an explicit \brief command for a brief description.)
     146
     147QT_AUTOBRIEF           = NO
    109148
    110149# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
     
    125164# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
    126165# member inherits the documentation from any documented member that it
    127 # reimplements.
     166# re-implements.
    128167
    129168INHERIT_DOCS           = YES
    130169
    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
     170# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
     171# a new page for each member. If set to NO, the documentation of a member will
     172# be part of the file/class/namespace that contains it.
     173
     174SEPARATE_MEMBER_PAGES  = NO
    137175
    138176# The TAB_SIZE tag can be used to set the number of spaces in a tab.
     
    150188ALIASES                =
    151189
    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.
     190# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
     191# sources only. Doxygen will then generate output that is more tailored for C.
    154192# For instance, some of the names that are used will be different. The list
    155193# of all members will be omitted, etc.
     
    157195OPTIMIZE_OUTPUT_FOR_C  = YES
    158196
    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.
     197# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
     198# sources only. Doxygen will then generate output that is more tailored for Java.
    161199# For instance, namespaces will be presented as packages, qualified scopes
    162200# will look different, etc.
    163201
    164202OPTIMIZE_OUTPUT_JAVA   = NO
     203
     204# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
     205# include (a tag file for) the STL sources as input, then you should
     206# set this tag to YES in order to let doxygen match functions declarations and
     207# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
     208# func(std::string) {}). This also make the inheritance and collaboration
     209# diagrams that involve STL classes more complete and accurate.
     210
     211BUILTIN_STL_SUPPORT    = NO
     212
     213# If you use Microsoft's C++/CLI language, you should set this option to YES to
     214# enable parsing support.
     215
     216CPP_CLI_SUPPORT        = NO
     217
     218# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
     219# Doxygen will parse them like normal C++ but will assume all classes use public
     220# instead of private inheritance when no explicit protection keyword is present.
     221
     222SIP_SUPPORT            = NO
     223
     224# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
     225# tag is set to YES, then doxygen will reuse the documentation of the first
     226# member in the group (if any) for the other members of the group. By default
     227# all members of a group must be documented explicitly.
     228
     229DISTRIBUTE_GROUP_DOC   = NO
    165230
    166231# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
     
    172237SUBGROUPING            = YES
    173238
     239# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct (or union) is
     240# documented as struct with the name of the typedef. So
     241# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
     242# with name TypeT. When disabled the typedef will appear as a member of a file,
     243# namespace, or class. And the struct will be named TypeS. This can typically
     244# be useful for C code where the coding convention is that all structs are
     245# typedef'ed and only the typedef is referenced never the struct's name.
     246
     247TYPEDEF_HIDES_STRUCT   = NO
     248
    174249#---------------------------------------------------------------------------
    175250# Build related configuration options
     
    198273
    199274EXTRACT_LOCAL_CLASSES  = YES
     275
     276# This flag is only useful for Objective-C code. When set to YES local
     277# methods, which are defined in the implementation section but not in
     278# the interface are included in the documentation.
     279# If set to NO (the default) only methods in the interface are included.
     280
     281EXTRACT_LOCAL_METHODS  = NO
     282
     283# If this flag is set to YES, the members of anonymous namespaces will be extracted
     284# and appear in the documentation as a namespace called 'anonymous_namespace{file}',
     285# where file will be replaced with the base name of the file that contains the anonymous
     286# namespace. By default anonymous namespace are hidden.
     287
     288EXTRACT_ANON_NSPACES   = NO
    200289
    201290# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
     
    239328# allowed. This is useful if you have classes or files whose names only differ
    240329# in case and if your file system supports case sensitive file names. Windows
    241 # users are advised to set this option to NO.
     330# and Mac users are advised to set this option to NO.
    242331
    243332CASE_SENSE_NAMES       = YES
     
    266355
    267356SORT_MEMBER_DOCS       = YES
     357
     358# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
     359# brief documentation of file, namespace and class members alphabetically
     360# by member name. If set to NO (the default) the members will appear in
     361# declaration order.
     362
     363SORT_BRIEF_DOCS        = NO
     364
     365# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
     366# sorted by fully-qualified names, including namespaces. If set to
     367# NO (the default), the class list will be sorted only by class name,
     368# not including the namespace part.
     369# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
     370# Note: This option applies only to the class list, not to the
     371# alphabetical list.
     372
     373SORT_BY_SCOPE_NAME     = NO
    268374
    269375# The GENERATE_TODOLIST tag can be used to enable (YES) or
     
    312418SHOW_USED_FILES        = YES
    313419
     420# If the sources in your project are distributed over multiple directories
     421# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
     422# in the documentation. The default is NO.
     423
     424SHOW_DIRECTORIES       = NO
     425
     426# The FILE_VERSION_FILTER tag can be used to specify a program or script that
     427# doxygen should invoke to get the current version for each file (typically from the
     428# version control system). Doxygen will invoke the program by executing (via
     429# popen()) the command <command> <input-file>, where <command> is the value of
     430# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
     431# provided by doxygen. Whatever the program writes to standard output
     432# is used as the file version. See the manual for examples.
     433
     434FILE_VERSION_FILTER    =
     435
    314436#---------------------------------------------------------------------------
    315437# configuration options related to warning and progress messages
     
    340462WARN_IF_DOC_ERROR      = YES
    341463
     464# This WARN_NO_PARAMDOC option can be abled to get warnings for
     465# functions that are documented, but have no documentation for their parameters
     466# or return value. If set to NO (the default) doxygen will only warn about
     467# wrong or incomplete parameter documentation, but not about the absence of
     468# documentation.
     469
     470WARN_NO_PARAMDOC       = NO
     471
    342472# The WARN_FORMAT tag determines the format of the warning messages that
    343473# doxygen can produce. The string should contain the $file, $line, and $text
    344474# tags, which will be replaced by the file and line number from which the
    345 # warning originated and the warning text.
    346 
    347 WARN_FORMAT            = "$file:$line: $text"
     475# warning originated and the warning text. Optionally the format may contain
     476# $version, which will be replaced by the version of the file (if it could
     477# be obtained via FILE_VERSION_FILTER)
     478
     479WARN_FORMAT            = "$file:$line: $text  "
    348480
    349481# The WARN_LOGFILE tag can be used to specify a file to which warning
     
    362494# with spaces.
    363495
    364 INPUT                  = include inline cpu/no_cpu
     496INPUT                  = include \
     497                         inline \
     498                         cpu/no_cpu
     499
     500# This tag can be used to specify the character encoding of the source files that
     501# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default
     502# input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding.
     503# See http://www.gnu.org/software/libiconv for the list of possible encodings.
     504
     505INPUT_ENCODING         = UTF-8
    365506
    366507# If the value of the INPUT tag contains directories, you can use the
     
    368509# and *.h) to filter out the source-files in the directories. If left
    369510# 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
     511# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
     512# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
     513
     514FILE_PATTERNS          = *.h \
     515                         *.inl
    374516
    375517# The RECURSIVE tag can be used to turn specify whether or not subdirectories
     
    385527EXCLUDE                =
    386528
    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.
     529# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
     530# directories that are symbolic links (a Unix filesystem feature) are excluded
     531# from the input.
    389532
    390533EXCLUDE_SYMLINKS       = NO
     
    392535# If the value of the INPUT tag contains directories, you can use the
    393536# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
    394 # certain files from those directories.
     537# certain files from those directories. Note that the wildcards are matched
     538# against the file with absolute path, so to exclude all test directories
     539# for example use the pattern */test/*
    395540
    396541EXCLUDE_PATTERNS       =
     542
     543# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
     544# (namespaces, classes, functions, etc.) that should be excluded from the output.
     545# The symbol name can be a fully qualified name, a word, or if the wildcard * is used,
     546# a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
     547
     548EXCLUDE_SYMBOLS        =
    397549
    398550# The EXAMPLE_PATH tag can be used to specify one or more files or
     
    427579# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
    428580# input file. Doxygen will then use the output that the filter program writes
    429 # to standard output.
     581# to standard output.  If FILTER_PATTERNS is specified, this tag will be
     582# ignored.
    430583
    431584INPUT_FILTER           =
     585
     586# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
     587# basis.  Doxygen will compare the file name with each pattern and apply the
     588# filter if there is a match.  The filters are a list of the form:
     589# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
     590# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
     591# is applied to all files.
     592
     593FILTER_PATTERNS        =
    432594
    433595# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
     
    442604
    443605# 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.
     606# be generated. Documented entities will be cross-referenced with these sources.
     607# Note: To get rid of all source code in the generated output, make sure also
     608# VERBATIM_HEADERS is set to NO. If you have enabled CALL_GRAPH or CALLER_GRAPH
     609# then you must also enable this option. If you don't then doxygen will produce
     610# a warning and turn it on anyway
    445611
    446612SOURCE_BROWSER         = NO
     
    468634
    469635REFERENCES_RELATION    = YES
     636
     637# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
     638# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
     639# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
     640# link to the source code.  Otherwise they will link to the documentstion.
     641
     642REFERENCES_LINK_SOURCE = YES
     643
     644# If the USE_HTAGS tag is set to YES then the references to source code
     645# will point to the HTML generated by the htags(1) tool instead of doxygen
     646# built-in source browser. The htags tool is part of GNU's global source
     647# tagging system (see http://www.gnu.org/software/global/global.html). You
     648# will need version 4.8.6 or higher.
     649
     650USE_HTAGS              = NO
    470651
    471652# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
     
    534715# style sheet that is used by each HTML page. It can be used to
    535716# fine-tune the look of the HTML output. If the tag is left blank doxygen
    536 # will generate a default style sheet
     717# will generate a default style sheet. Note that doxygen will try to copy
     718# the style sheet file to the HTML output directory, so don't put your own
     719# stylesheet in the HTML output directory as well, or it will be erased!
    537720
    538721HTML_STYLESHEET        =
     
    551734GENERATE_HTMLHELP      = NO
    552735
     736# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
     737# documentation will contain sections that can be hidden and shown after the
     738# page has loaded. For this to work a browser that supports
     739# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
     740# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
     741
     742HTML_DYNAMIC_SECTIONS  = NO
     743
    553744# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
    554745# be used to specify the file name of the resulting .chm file. You
    555746# can add a path in front of the file if the result should not be
    556 # written to the html output dir.
     747# written to the html output directory.
    557748
    558749CHM_FILE               =
     
    689880
    690881# 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
     882# The RTF output is optimized for Word 97 and may not look very pretty with
    692883# other RTF readers or editors.
    693884
     
    716907
    717908# 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
     909# config file, i.e. a series of assignments. You only have to provide
    719910# replacements, missing definitions are set to their default value.
    720911
     
    760951# If the GENERATE_XML tag is set to YES Doxygen will
    761952# 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.
     953# the code including all documentation.
    765954
    766955GENERATE_XML           = NO
     
    783972
    784973XML_DTD                =
     974
     975# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
     976# dump the program listings (including syntax highlighting
     977# and cross-referencing information) to the XML output. Note that
     978# enabling this will significantly increase the size of the XML output.
     979
     980XML_PROGRAMLISTING     = YES
    785981
    786982#---------------------------------------------------------------------------
     
    8481044# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
    8491045# then the macro expansion is limited to the macros specified with the
    850 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
     1046# PREDEFINED and EXPAND_AS_DEFINED tags.
    8511047
    8521048EXPAND_ONLY_PREDEF     = NO
     
    8741070# gcc). The argument of the tag is a list of macros of the form: name
    8751071# or name=definition (no spaces). If the definition and the = are
    876 # omitted =1 is assumed.
     1072# omitted =1 is assumed. To prevent a macro definition from being
     1073# undefined via #undef or recursively expanded use the := operator
     1074# instead of the = operator.
    8771075
    8781076PREDEFINED             = FALSE=0 \
    879    CPU_USE_GENERIC_BITFIELD_DATA=0
     1077                         CPU_USE_GENERIC_BITFIELD_DATA=0
    8801078
    8811079# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
     
    8891087# doxygen's preprocessor will remove all function-like macros that are alone
    8901088# 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.
     1089# function macros are typically used for boiler-plate code, and will confuse
     1090# the parser if not removed.
    8931091
    8941092SKIP_FUNCTION_MACROS   = YES
    8951093
    8961094#---------------------------------------------------------------------------
    897 # Configuration::addtions related to external references   
     1095# Configuration::additions related to external references   
    8981096#---------------------------------------------------------------------------
    8991097
     
    9421140
    9431141# 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.
     1142# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
     1143# or super classes. Setting the tag to NO turns the diagrams off. Note that
     1144# this option is superseded by the HAVE_DOT option below. This is only a
     1145# fallback. It is recommended to install and use dot, since it yields more
     1146# powerful graphs.
    9481147
    9491148CLASS_DIAGRAMS         = YES
     1149
     1150# You can define message sequence charts within doxygen comments using the \msc
     1151# command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to
     1152# produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to
     1153# specify the directory where the mscgen tool resides. If left empty the tool is assumed to
     1154# be found in the default search path.
     1155
     1156MSCGEN_PATH            =
    9501157
    9511158# If set to YES, the inheritance and collaboration graphs will hide
     
    9761183COLLABORATION_GRAPH    = YES
    9771184
     1185# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
     1186# will generate a graph for groups, showing the direct groups dependencies
     1187
     1188GROUP_GRAPHS           = YES
     1189
    9781190# 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
     1191# collaboration diagrams in a style similar to the OMG's Unified Modeling
    9801192# Language.
    9811193
     
    10011213INCLUDED_BY_GRAPH      = YES
    10021214
    1003 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
     1215# If the CALL_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will
    10041216# generate a call dependency graph for every global function or class method.
    10051217# Note that enabling this option will significantly increase the time of a run.
     
    10091221CALL_GRAPH             = NO
    10101222
     1223# If the CALLER_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will
     1224# generate a caller dependency graph for every global function or class method.
     1225# Note that enabling this option will significantly increase the time of a run.
     1226# So in most cases it will be better to enable caller graphs for selected
     1227# functions only using the \callergraph command.
     1228
     1229CALLER_GRAPH           = NO
     1230
    10111231# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
    10121232# will graphical hierarchy of all classes instead of a textual one.
    10131233
    10141234GRAPHICAL_HIERARCHY    = YES
     1235
     1236# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
     1237# then doxygen will show the dependencies a directory has on other directories
     1238# in a graphical way. The dependency relations are determined by the #include
     1239# relations between the files in the directories.
     1240
     1241DIRECTORY_GRAPH        = YES
    10151242
    10161243# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
     
    10211248
    10221249# 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.
     1250# found. If left blank, it is assumed the dot tool can be found in the path.
    10241251
    10251252DOT_PATH               =
     
    10311258DOTFILE_DIRS           =
    10321259
    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
     1260# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
     1261# nodes that will be shown in the graph. If the number of nodes in a graph
     1262# becomes larger than this value, doxygen will truncate the graph, which is
     1263# visualized by representing a node as a red box. Note that doxygen if the number
     1264# of direct children of the root node in a graph is already larger than
     1265# MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note
     1266# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
     1267
     1268DOT_GRAPH_MAX_NODES    = 50
    10481269
    10491270# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
    10501271# 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.
     1272# from the root by following a path via at most 3 edges will be shown. Nodes
     1273# that lay further from the root node will be omitted. Note that setting this
     1274# option to 1 or 2 may greatly reduce the computation time needed for large
     1275# code bases. Also note that the size of a graph can be further restricted by
     1276# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
    10571277
    10581278MAX_DOT_GRAPH_DEPTH    = 0
     1279
     1280# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
     1281# background. This is disabled by default, which results in a white background.
     1282# Warning: Depending on the platform used, enabling this option may lead to
     1283# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
     1284# read).
     1285
     1286DOT_TRANSPARENT        = YES
     1287
     1288# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
     1289# files in one run (i.e. multiple -o and -T options on the command line). This
     1290# makes dot run faster, but since only newer versions of dot (>1.8.10)
     1291# support this, this feature is disabled by default.
     1292
     1293DOT_MULTI_TARGETS      = NO
    10591294
    10601295# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
     
    10711306
    10721307#---------------------------------------------------------------------------
    1073 # Configuration::addtions related to the search engine   
     1308# Configuration::additions related to the search engine   
    10741309#---------------------------------------------------------------------------
    10751310
  • cpukit/score/include/rtems/score/apimutex.h

    r95e7637 r18ca4e8  
    88
    99/*
    10  *  COPYRIGHT (c) 1989-2007.
     10 *  COPYRIGHT (c) 1989-2008.
    1111 *  On-Line Applications Research Corporation (OAR).
    1212 *
     
    8585 *  This routine releases the specified API mutex.
    8686 *
    87  *  @param[in] _the_mutex is the mutex to release.
     87 *  @param[in] the_mutex is the mutex to release.
    8888 */
    8989void _API_Mutex_Unlock(
  • cpukit/score/include/rtems/score/corebarrier.h

    r95e7637 r18ca4e8  
    177177 *  associated wait queue.
    178178 *
    179  *  @param[in] the_barrier is the barrier to flush
    180  *  @param[in] remote_extract_callout is the routine to invoke if the
     179 *  @param[in] _the_barrier is the barrier to flush
     180 *  @param[in] _remote_extract_callout is the routine to invoke if the
    181181 *         thread unblocked is remote
    182  *  @param[in] status is the status to be returned to the unblocked thread
     182 *  @param[in] _status is the status to be returned to the unblocked thread
    183183 */
    184184#define _CORE_barrier_Flush( _the_barrier, _remote_extract_callout, _status) \
  • cpukit/score/include/rtems/score/coremutex.h

    r95e7637 r18ca4e8  
    99
    1010/*
    11  *  COPYRIGHT (c) 1989-2007.
     11 *  COPYRIGHT (c) 1989-2008.
    1212 *  On-Line Applications Research Corporation (OAR).
    1313 *
     
    293293
    294294#if defined(__RTEMS_DO_NOT_INLINE_CORE_MUTEX_SEIZE__)
    295   /*
     295  /**
    296296   *  When doing test coverage analysis or trying to minimize the code
    297297   *  space for RTEMS, it is often helpful to not inline this method
    298298   *  multiple times.  It is fairly large and has a high branch complexity
    299299   *  which makes it harder to get full binary test coverage.
     300   *
     301   *  @param[in] the_mutex will attempt to lock
     302   *  @param[in] level_p is the interrupt level holder
    300303   */
    301304  int _CORE_mutex_Seize_interrupt_trylock(
     
    304307  );
    305308#else
    306   /*
     309  /**
    307310   *  The default is to favor speed and inlining this definitely saves
    308311   *  a few instructions.  This is very important for mutex performance.
    309    */
    310   #define _CORE_mutex_Seize_interrupt_trylock( _mutex, _level ) \
    311      _CORE_mutex_Seize_interrupt_trylock_body( _mutex, _level )
     312   * 
     313   *  @param[in] _mutex will attempt to lock
     314   *  @param[in] _level_p is the interrupt level holder
     315   */
     316  #define _CORE_mutex_Seize_interrupt_trylock( _mutex, _level_p ) \
     317     _CORE_mutex_Seize_interrupt_trylock_body( _mutex, _level_p )
    312318#endif
    313319
     
    344350 *        with context switching disabled, or before multitasking,
    345351 *        then a fatal error is generated.
    346  *
    347352 *
    348353 *  The logic on this routine is as follows:
     
    385390  } while (0)
    386391
     392/**
     393 *  This method is used to obtain a core mutex.
     394 *
     395 *  @param[in] _the_mutex is the mutex to attempt to lock
     396 *  @param[in] _id is the Id of the owning API level Semaphore object
     397 *  @param[in] _wait is TRUE if the thread is willing to wait
     398 *  @param[in] _timeout is the maximum number of ticks to block
     399 *  @param[in] _level is a temporary variable used to contain the ISR
     400 *         disable level cookie
     401 */
    387402#if defined(__RTEMS_DO_NOT_INLINE_CORE_MUTEX_SEIZE__)
    388403  void _CORE_mutex_Seize(
  • cpukit/score/include/rtems/score/corerwlock.h

    r95e7637 r18ca4e8  
    77
    88/*
    9  *  COPYRIGHT (c) 1989-2006.
     9 *  COPYRIGHT (c) 1989-2008.
    1010 *  On-Line Applications Research Corporation (OAR).
    1111 *
     
    194194 *  associated wait queue.
    195195 *
    196  *  @param[in] the_rwlock is the RWLock to flush
    197  *  @param[in] remote_extract_callout is the routine to invoke if the
     196 *  @param[in] _the_rwlock is the RWLock to flush
     197 *  @param[in] _remote_extract_callout is the routine to invoke if the
    198198 *         thread unblocked is remote
    199  *  @param[in] status is the status to be returned to the unblocked thread
     199 *  @param[in] _status is the status to be returned to the unblocked thread
    200200 */
    201201#define _CORE_RWLock_Flush( _the_rwlock, _remote_extract_callout, _status) \
  • cpukit/score/include/rtems/score/heap.h

    r95e7637 r18ca4e8  
    142142 *        the overhead is too high for your application.
    143143 */
    144 
    145 typedef struct Heap_Statistics_tag {
     144typedef struct {
    146145  /** instance number of this heap */
    147146  uint32_t instance;
  • cpukit/score/include/rtems/score/object.h

    r95e7637 r18ca4e8  
    430430#define OBJECTS_ID_FINAL           ((Objects_Id)~0)
    431431
     432#if defined(RTEMS_MULTIPROCESSING)
    432433/**
    433434 *  This function performs the initialization necessary for this handler.
     
    439440 */
    440441void _Objects_Handler_initialization(
    441 #if defined(RTEMS_MULTIPROCESSING)
    442442  uint32_t   node,
    443443  uint32_t   maximum_nodes,
    444444  uint32_t   maximum_global_objects
    445 #endif
    446 );
     445);
     446#else
     447/**
     448 *  This function performs the initialization necessary for this handler.
     449 */
     450void _Objects_Handler_initialization(void);
     451#endif
    447452
    448453/**
     
    500505/**
    501506 *  This function returns the highest numeric value of a valid
    502  *  API for the specified @code{api}.
     507 *  API for the specified @a api.
    503508 *
    504509 *  @param[in] api is the API of interest
     
    551556 *  This macro is used to build a thirty-two bit style name from
    552557 *  four characters.  The most significant byte will be the
    553  *  character @code{_C1}.
     558 *  character @a _C1.
    554559 *
    555560 *  @param[in] _C1 is the first character of the name
     
    582587} Objects_Name_or_id_lookup_errors;
    583588
    584 /** This macro defines the first entry in the
     589/**
     590 *  This macro defines the first entry in the
    585591 *  @ref Objects_Name_or_id_lookup_errors enumerated list.
    586592 */
    587593#define OBJECTS_NAME_ERRORS_FIRST OBJECTS_NAME_OR_ID_LOOKUP_SUCCESSFUL
    588594
    589 /** This macro defines the last entry in the
     595/**
     596 *  This macro defines the last entry in the
    590597 *  @ref Objects_Name_or_id_lookup_errors enumerated list.
    591598 */
     
    798805 *
    799806 *  @param[in] api indicates the API for the information we want
    800  *  @param[in] api indicates the Class for the information we want
    801  *
     807 *  @param[in] class indicates the Class for the information we want
    802808 *
    803809 *  @return This method returns a pointer to the Object Information Table
     
    815821 *  @param[in] id is an object ID
    816822 *
    817  *
    818823 *  @return This method returns a pointer to the Object Information Table
    819824 *          for the class of objects which corresponds to this object ID.
     
    830835 *  @param[in] id is the object to obtain the name of
    831836 *  @param[in] length indicates the length of the caller's buffer
    832  *  @param[inout] name is a string which will be filled in.
    833  *
    834  *  @return This method returns @a name or NULL on error.
     837 *  @param[in] name points a string which will be filled in.
     838 *
     839 *  @return This method returns @a name or NULL on error. @a *name will
     840 *          contain the name if successful.
    835841 */
    836842char *_Objects_Get_name_as_string(
  • cpukit/score/include/rtems/score/protectedheap.h

    r95e7637 r18ca4e8  
    140140 *         to be resized
    141141 *  @param[in] size is the new size
    142  *  @param[in] old_mem_size points to a user area to return the size of the
    143  *  @return TRUE if successfully able to resize the block,
    144  *          FALSE if the block can't be resized in place,
     142 *
     143 *  @return TRUE if successfully able to resize the block.
     144 *          FALSE if the block can't be resized in place.
    145145 */
    146146boolean _Protected_heap_Resize_block(
  • cpukit/score/include/rtems/score/thread.h

    r95e7637 r18ca4e8  
    3737 */
    3838#ifndef __RTEMS_USE_TICKS_CPU_USAGE_STATISTICS__
    39   /*
    40    *  Enable the nanosecond accurate statistics
     39  /**
     40   *  This macro enables the nanosecond accurate statistics
    4141   *
    4242   *  When not defined, the older style tick accurate granularity
  • cpukit/score/include/rtems/score/threadsync.h

    r95e7637 r18ca4e8  
    2222
    2323/**
    24  *  @defgroup ScoreThread Thread Blocking Operation Synchronization Handler
     24 *  @defgroup ScoreThreadSync Thread Blocking Operation Synchronization Handler
    2525 *
    2626 *  This handler encapsulates functionality related to the management of
  • cpukit/score/include/rtems/score/tod.h

    r95e7637 r18ca4e8  
    77
    88/*
    9  *  COPYRIGHT (c) 1989-2007.
     9 *  COPYRIGHT (c) 1989-2008.
    1010 *  On-Line Applications Research Corporation (OAR).
    1111 *
     
    2020#define _RTEMS_SCORE_TOD_H
    2121
    22 /**
    23  *  @defgroup ScoreTOD Time Of Day (TOD) Handler
    24  *
    25  *  This handler encapsulates functionality used to manage time of day.
    26  */
    27 /**@{*/
    28 
    2922#ifdef __cplusplus
    3023extern "C" {
     
    3528
    3629/** @defgroup ScoreTODConstants TOD Constants
    37  *  The following constants are related to the time of day.
     30 *  The following constants are related to the time of day and are
     31 *  independent of RTEMS.
    3832 */
    3933/**@{*/
     
    9791#define TOD_NANOSECONDS_PER_MICROSECOND (uint32_t)1000
    9892
    99 /*
     93/**@}*/
     94
     95/**
    10096 *  Seconds from January 1, 1970 to January 1, 1988.  Used to account for
    10197 *  differences between POSIX API and RTEMS core. The timespec format time
     
    106102  (4 * TOD_SECONDS_PER_DAY))
    107103
    108 /**@}*/
    109 
    110104/**  @brief Ticks per Second
    111105 * 
     
    124118#define TOD_BASE_YEAR 1988
    125119
     120/**
     121 *  @defgroup ScoreTOD Time Of Day (TOD) Handler
     122 *
     123 *  This handler encapsulates functionality used to manage time of day.
     124 */
     125/**@{*/
     126
    126127/** @brief Is the Time Of Day Set
    127128 *
  • cpukit/score/inline/rtems/score/corerwlock.inl

    r95e7637 r18ca4e8  
    11/**
    2  *  @file  rtems/score/coreRWLock.inl
     2 *  @file  rtems/score/corerwlock.inl
    33 *
    44 *  This include file contains all of the inlined routines associated
     
    77
    88/*
    9  *  COPYRIGHT (c) 1989-2006.
     9 *  COPYRIGHT (c) 1989-2008.
    1010 *  On-Line Applications Research Corporation (OAR).
    1111 *
  • cpukit/score/inline/rtems/score/corespinlock.inl

    r95e7637 r18ca4e8  
    77
    88/*
    9  *  COPYRIGHT (c) 1989-2006.
     9 *  COPYRIGHT (c) 1989-2008.
    1010 *  On-Line Applications Research Corporation (OAR).
    1111 *
     
    2525 */
    2626
     27/**
     28 *
     29 *  This method is used to determine if the spinlock is available or not.
     30 *
     31 *  @param[in] the_spinlock will be checked
     32 *
     33 *  @return This method will return TRUE if the spinlock is busy
     34 *          and FALSE otherwise.
     35 */
    2736RTEMS_INLINE_ROUTINE boolean _CORE_spinlock_Is_busy(
    2837  CORE_spinlock_Control  *the_spinlock
     
    3241}
    3342
    34 
    3543/**@}*/
    3644
Note: See TracChangeset for help on using the changeset viewer.