diff options
author | jm <jm@0101bb08-14d6-0310-b084-bc0e0c8e3800> | 2005-08-31 03:21:21 +0400 |
---|---|---|
committer | jm <jm@0101bb08-14d6-0310-b084-bc0e0c8e3800> | 2005-08-31 03:21:21 +0400 |
commit | 87c93668a105a2772622b24b54af00bfa170c1a5 (patch) | |
tree | 4ec3f117764d9fd65a61913b5c080171790d0b85 | |
parent | 295b55854897782b9a9815e45d759aefae053333 (diff) |
Improved Doxygen comments
git-svn-id: http://svn.xiph.org/trunk/speex@9873 0101bb08-14d6-0310-b084-bc0e0c8e3800
36 files changed, 799 insertions, 356 deletions
@@ -1,4 +1,4 @@ -# Doxyfile 1.2.14 +# Doxyfile 1.4.2 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project @@ -11,37 +11,209 @@ # Values that contain spaces should be placed between quotes (" ") #--------------------------------------------------------------------------- -# General configuration options +# Project related configuration options #--------------------------------------------------------------------------- # The PROJECT_NAME tag is a single word (or a sequence of words surrounded # by quotes) that should identify the project. -PROJECT_NAME = Speex +PROJECT_NAME = Speex # The PROJECT_NUMBER tag can be used to enter a project or revision number. # This could be handy for archiving the generated documentation or # if some version control system is used. -PROJECT_NUMBER = 1.1.10 +PROJECT_NUMBER = 1.1.10 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) # base path where the generated documentation will be put. # If a relative path is entered, it will be relative to the location # where doxygen was started. If left blank the current directory will be used. -OUTPUT_DIRECTORY = doc +OUTPUT_DIRECTORY = doc + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +# 4096 sub-directories (in 2 levels) under the output directory of each output +# format and will distribute the generated files over these directories. +# Enabling this option can be useful when feeding doxygen a huge amount of +# source files, where putting all generated files in the same directory would +# otherwise cause performance problems for the file system. + +CREATE_SUBDIRS = NO # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. # The default language is English, other supported languages are: -# Brazilian, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French, -# German, Greek, Hungarian, Italian, Japanese, Korean, Norwegian, Polish, -# Portuguese, Romanian, Russian, Slovak, Slovene, Spanish and Swedish. +# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, +# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, +# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, +# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, +# Swedish, and Ukrainian. OUTPUT_LANGUAGE = English +# This tag can be used to specify the encoding used in the generated output. +# The encoding is not always determined by the language that is chosen, +# but also whether or not the output is meant for Windows or non-Windows users. +# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES +# forces the Windows encoding (this is the default for the Windows binary), +# whereas setting the tag to NO uses a Unix-style encoding (the default for +# all platforms other than Windows). + +USE_WINDOWS_ENCODING = NO + +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). +# Set to NO to disable this. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is +# used as the annotated text. Otherwise, the brief description is used as-is. +# If left blank, the following values are used ("$name" is automatically +# replaced with the name of the entity): "The $name class" "The $name widget" +# "The $name file" "is" "provides" "specifies" "contains" +# "represents" "a" "an" "the" + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +# path before files name in the file list and in the header files. If set +# to NO the shortest path that makes the file name unique will be used. + +FULL_PATH_NAMES = NO + +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user-defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the +# path to strip. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of +# the path mentioned in the documentation of a class, which tells +# the reader which header file to include in order to use a class. +# If left blank only the name of the header file containing the class +# definition is used. Otherwise one should specify the include paths that +# are normally passed to the compiler using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful is your file systems +# doesn't support long names like on DOS, Mac, or CD-ROM. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +# will interpret the first line (until the first dot) of a JavaDoc-style +# comment as the brief description. If set to NO, the JavaDoc +# comments will behave just like the Qt-style comments (thus requiring an +# explicit @brief command for a brief description. + +JAVADOC_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +# treat a multi-line C++ special comment block (i.e. a block of //! or /// +# comments) as a brief description. This used to be the default behaviour. +# The new default is to treat a multi-line C++ comment block as a detailed +# description. Set this tag to YES if you prefer the old behaviour instead. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the DETAILS_AT_TOP tag is set to YES then Doxygen +# will output the detailed description near the top, like JavaDoc. +# If set to NO, the detailed description appears after the member +# documentation. + +DETAILS_AT_TOP = NO + +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it +# re-implements. + +INHERIT_DOCS = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. + +DISTRIBUTE_GROUP_DOC = NO + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce +# a new page for each member. If set to NO, the documentation of a member will +# be part of the file/class/namespace that contains it. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# Doxygen uses this value to replace tabs by spaces in code fragments. + +TAB_SIZE = 8 + +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". +# You can put \n's in the value part of an alias to insert newlines. + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C +# sources only. Doxygen will then generate output that is more tailored for C. +# For instance, some of the names that are used will be different. The list +# of all members will be omitted, etc. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources +# only. Doxygen will then generate output that is more tailored for Java. +# For instance, namespaces will be presented as packages, qualified scopes +# will look different, etc. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using +# the \nosubgrouping command. + +SUBGROUPING = YES + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in # documentation are documented, even if no documentation was available. # Private class members and static file members will be hidden unless @@ -65,6 +237,13 @@ EXTRACT_STATIC = NO EXTRACT_LOCAL_CLASSES = YES +# This flag is only useful for Objective-C code. When set to YES local +# methods, which are defined in the implementation section but not in +# the interface are included in the documentation. +# If set to NO (the default) only methods in the interface are included. + +EXTRACT_LOCAL_METHODS = NO + # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all # undocumented members of documented classes, files or namespaces. # If set to NO (the default) these members will be included in the @@ -75,50 +254,24 @@ HIDE_UNDOC_MEMBERS = NO # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. -# If set to NO (the default) these class will be included in the various +# If set to NO (the default) these classes will be included in the various # overviews. This option has no effect if EXTRACT_ALL is enabled. HIDE_UNDOC_CLASSES = NO -# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will -# include brief member descriptions after the members that are listed in -# the file and class documentation (similar to JavaDoc). -# Set to NO to disable this. - -BRIEF_MEMBER_DESC = YES - -# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend -# the brief description of a member or function before the detailed description. -# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the -# brief descriptions will be completely suppressed. - -REPEAT_BRIEF = YES - -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# Doxygen will generate a detailed section even if there is only a brief -# description. - -ALWAYS_DETAILED_SEC = NO - -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited -# members of a class in the documentation of that class as if those members were -# ordinary class members. Constructors, destructors and assignment operators of -# the base classes will not be shown. - -INLINE_INHERITED_MEMB = NO +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the +# documentation. -# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full -# path before files name in the file list and in the header files. If set -# to NO the shortest path that makes the file name unique will be used. +HIDE_FRIEND_COMPOUNDS = NO -FULL_PATH_NAMES = NO +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the +# function's detailed documentation block. -# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag -# can be used to strip a user defined part of the path. Stripping is -# only done if one of the specified strings matches the left-hand part of -# the path. It is allowed to use relative paths in the argument list. - -STRIP_FROM_PATH = +HIDE_IN_BODY_DOCS = NO # The INTERNAL_DOCS tag determines if documentation # that is typed after a \internal command is included. If the tag is set @@ -127,58 +280,26 @@ STRIP_FROM_PATH = INTERNAL_DOCS = NO -# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct -# doxygen to hide any special comment blocks from generated source code -# fragments. Normal C and C++ comments will always remain visible. - -STRIP_CODE_COMMENTS = YES - # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate -# file names in lower case letters. If set to YES upper case letters are also +# file names in lower-case letters. If set to YES upper-case letters are also # allowed. This is useful if you have classes or files whose names only differ # in case and if your file system supports case sensitive file names. Windows -# users are adviced to set this option to NO. +# and Mac users are advised to set this option to NO. CASE_SENSE_NAMES = YES -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter -# (but less readable) file names. This can be useful is your file systems -# doesn't support long names like on DOS, Mac, or CD-ROM. - -SHORT_NAMES = NO - # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen # will show members with their full class and namespace scopes in the # documentation. If set to YES the scope will be hidden. HIDE_SCOPE_NAMES = NO -# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen -# will generate a verbatim copy of the header file for each class for -# which an include is specified. Set to NO to disable this. - -VERBATIM_HEADERS = YES - # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen -# will put list of the files that are included by a file in the documentation +# will put a list of the files that are included by a file in the documentation # of that file. SHOW_INCLUDE_FILES = YES -# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen -# will interpret the first line (until the first dot) of a JavaDoc-style -# comment as the brief description. If set to NO, the JavaDoc -# comments will behave just like the Qt-style comments (thus requiring an -# explict @brief command for a brief description. - -JAVADOC_AUTOBRIEF = NO - -# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented -# member inherits the documentation from any documented member that it -# reimplements. - -INHERIT_DOCS = YES - # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] # is inserted in the documentation for inline members. @@ -191,17 +312,22 @@ INLINE_INFO = YES SORT_MEMBER_DOCS = YES -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES, then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default -# all members of a group must be documented explicitly. +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in +# declaration order. -DISTRIBUTE_GROUP_DOC = NO +SORT_BRIEF_DOCS = NO -# The TAB_SIZE tag can be used to set the number of spaces in a tab. -# Doxygen uses this value to replace tabs by spaces in code fragments. +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the +# alphabetical list. -TAB_SIZE = 8 +SORT_BY_SCOPE_NAME = NO # The GENERATE_TODOLIST tag can be used to enable (YES) or # disable (NO) the todo list. This list is created by putting \todo @@ -221,14 +347,11 @@ GENERATE_TESTLIST = YES GENERATE_BUGLIST = YES -# This tag can be used to specify a number of aliases that acts -# as commands in the documentation. An alias has the form "name=value". -# For example adding "sideeffect=\par Side Effects:\n" will allow you to -# put the command \sideeffect (or @sideeffect) in the documentation, which -# will result in a user defined paragraph with heading "Side Effects:". -# You can put \n's in the value part of an alias to insert newlines. +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting +# \deprecated commands in the documentation. -ALIASES = +GENERATE_DEPRECATEDLIST= YES # The ENABLED_SECTIONS tag can be used to enable conditional # documentation sections, marked by \if sectionname ... \endif. @@ -236,7 +359,7 @@ ALIASES = ENABLED_SECTIONS = # The MAX_INITIALIZER_LINES tag determines the maximum number of lines -# the initial value of a variable or define consist of for it to appear in +# the initial value of a variable or define consists of for it to appear in # the documentation. If the initializer consists of more lines than specified # here it will be hidden. Use a value of 0 to hide initializers completely. # The appearance of the initializer of individual variables and defines in the @@ -245,19 +368,28 @@ ENABLED_SECTIONS = MAX_INITIALIZER_LINES = 30 -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources -# only. Doxygen will then generate output that is more tailored for C. -# For instance some of the names that are used will be different. The list -# of all members will be omitted, etc. - -OPTIMIZE_OUTPUT_FOR_C = NO - # Set the SHOW_USED_FILES tag to NO to disable the list of files generated # at the bottom of the documentation of classes and structs. If set to YES the # list will mention the files that were used to generate the documentation. SHOW_USED_FILES = YES +# If the sources in your project are distributed over multiple directories +# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy +# in the documentation. + +SHOW_DIRECTORIES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from the +# version control system). Doxygen will invoke the program by executing (via +# popen()) the command <command> <input-file>, where <command> is the value of +# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file +# provided by doxygen. Whatever the progam writes to standard output +# is used as the file version. See the manual for examples. + +FILE_VERSION_FILTER = + #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- @@ -279,10 +411,27 @@ WARNINGS = YES WARN_IF_UNDOCUMENTED = YES +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that +# don't exist or using markup commands wrongly. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be abled to get warnings for +# functions that are documented, but have no documentation for their parameters +# or return value. If set to NO (the default) doxygen will only warn about +# wrong or incomplete parameter documentation, but not about the absence of +# documentation. + +WARN_NO_PARAMDOC = NO + # The WARN_FORMAT tag determines the format of the warning messages that # doxygen can produce. The string should contain the $file, $line, and $text # tags, which will be replaced by the file and line number from which the -# warning originated and the warning text. +# warning originated and the warning text. Optionally the format may contain +# $version, which will be replaced by the version of the file (if it could +# be obtained via FILE_VERSION_FILTER) WARN_FORMAT = "$file:$line: $text" @@ -301,14 +450,15 @@ WARN_LOGFILE = # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = include/speex libspeex +INPUT = include/speex \ + libspeex # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp # and *.h) to filter out the source-files in the directories. If left # blank the following patterns are tested: -# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp -# *.h++ *.idl *.odl +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx +# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm FILE_PATTERNS = @@ -322,10 +472,11 @@ RECURSIVE = NO # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = -# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories -# that are symbolic links (a Unix filesystem feature) are excluded from the input. +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or +# directories that are symbolic links (a Unix filesystem feature) are excluded +# from the input. EXCLUDE_SYMLINKS = NO @@ -333,7 +484,7 @@ EXCLUDE_SYMLINKS = NO # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude # certain files from those directories. -EXCLUDE_PATTERNS = +EXCLUDE_PATTERNS = speex_config_types.h # The EXAMPLE_PATH tag can be used to specify one or more files or # directories that contain example code fragments that are included (see @@ -366,13 +517,23 @@ IMAGE_PATH = # by executing (via popen()) the command <filter> <input-file>, where <filter> # is the value of the INPUT_FILTER tag, and <input-file> is the name of an # input file. Doxygen will then use the output that the filter program writes -# to standard output. +# to standard output. If FILTER_PATTERNS is specified, this tag will be +# ignored. INPUT_FILTER = +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further +# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER +# is applied to all files. + +FILTER_PATTERNS = + # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using # INPUT_FILTER) will be used to filter the input files when producing source -# files to browse. +# files to browse (i.e. when SOURCE_BROWSER is set to YES). FILTER_SOURCE_FILES = NO @@ -381,7 +542,9 @@ FILTER_SOURCE_FILES = NO #--------------------------------------------------------------------------- # If the SOURCE_BROWSER tag is set to YES then a list of source files will -# be generated. Documented entities will be cross-referenced with these sources. +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also +# VERBATIM_HEADERS is set to NO. SOURCE_BROWSER = NO @@ -390,6 +553,12 @@ SOURCE_BROWSER = NO INLINE_SOURCES = NO +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code +# fragments. Normal C and C++ comments will always remain visible. + +STRIP_CODE_COMMENTS = YES + # If the REFERENCED_BY_RELATION tag is set to YES (the default) # then for each documented function all documented # functions referencing it will be listed. @@ -402,6 +571,12 @@ REFERENCED_BY_RELATION = YES REFERENCES_RELATION = YES +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for +# which an include is specified. Set to NO to disable this. + +VERBATIM_HEADERS = YES + #--------------------------------------------------------------------------- # configuration options related to the alphabetical class index #--------------------------------------------------------------------------- @@ -458,10 +633,12 @@ HTML_HEADER = HTML_FOOTER = -# The HTML_STYLESHEET tag can be used to specify a user defined cascading +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading # style sheet that is used by each HTML page. It can be used to # fine-tune the look of the HTML output. If the tag is left blank doxygen -# will generate a default style sheet +# will generate a default style sheet. Note that doxygen will try to copy +# the style sheet file to the HTML output directory, so don't put your own +# stylesheet in the HTML output directory as well, or it will be erased! HTML_STYLESHEET = @@ -478,6 +655,20 @@ HTML_ALIGN_MEMBERS = YES GENERATE_HTMLHELP = NO +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be +# written to the html output directory. + +CHM_FILE = + +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# the HTML help compiler on the generated index.hhp. + +HHC_LOCATION = + # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag # controls if a separate .chi index file is generated (YES) or that # it should be included in the master .chm file (NO). @@ -491,7 +682,7 @@ GENERATE_CHI = NO BINARY_TOC = NO # The TOC_EXPAND flag can be set to YES to add extra items for group members -# to the contents of the Html help documentation and to the tree view. +# to the contents of the HTML help documentation and to the tree view. TOC_EXPAND = NO @@ -509,10 +700,9 @@ ENUM_VALUES_PER_LINE = 4 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be # generated containing a tree-like index structure (just like the one that # is generated for HTML Help). For this to work a browser that supports -# JavaScript and frames is required (for instance Mozilla, Netscape 4.0+, -# or Internet explorer 4.0+). Note that for large projects the tree generation -# can take a very long time. In such cases it is better to disable this feature. -# Windows users are probably better off using the HTML help feature. +# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, +# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are +# probably better off using the HTML help feature. GENERATE_TREEVIEW = NO @@ -537,6 +727,17 @@ GENERATE_LATEX = YES LATEX_OUTPUT = latex +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. If left blank `latex' will be used as the default command name. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the +# default command name. + +MAKEINDEX_CMD_NAME = makeindex + # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact # LaTeX documents. This may be useful for small projects and may help to # save some trees in general. @@ -581,12 +782,18 @@ USE_PDFLATEX = YES LATEX_BATCHMODE = NO +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) +# in the output. + +LATEX_HIDE_INDICES = NO + #--------------------------------------------------------------------------- # configuration options related to the RTF output #--------------------------------------------------------------------------- # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output -# The RTF output is optimised for Word 97 and may not look very pretty with +# The RTF output is optimized for Word 97 and may not look very pretty with # other RTF readers or editors. GENERATE_RTF = NO @@ -613,7 +820,7 @@ COMPACT_RTF = NO RTF_HYPERLINKS = NO # Load stylesheet definitions from file. Syntax is similar to doxygen's -# config file, i.e. a series of assigments. You only have to provide +# config file, i.e. a series of assignments. You only have to provide # replacements, missing definitions are set to their default value. RTF_STYLESHEET_FILE = @@ -657,12 +864,35 @@ MAN_LINKS = NO # If the GENERATE_XML tag is set to YES Doxygen will # generate an XML file that captures the structure of -# the code including all documentation. Note that this -# feature is still experimental and incomplete at the -# moment. +# the code including all documentation. GENERATE_XML = NO +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `xml' will be used as the default path. + +XML_OUTPUT = xml + +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_SCHEMA = + +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_DTD = + +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that +# enabling this will significantly increase the size of the XML output. + +XML_PROGRAMLISTING = YES + #--------------------------------------------------------------------------- # configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- @@ -676,6 +906,39 @@ GENERATE_XML = NO GENERATE_AUTOGEN_DEF = NO #--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the +# moment. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# to generate PDF and DVI output from the Perl module output. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. This is useful +# if you want to understand what is going on. On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller +# and Perl will parse it just the same. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same +# Makefile don't overwrite each other's variables. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- # Configuration options related to the preprocessor #--------------------------------------------------------------------------- @@ -720,11 +983,13 @@ INCLUDE_FILE_PATTERNS = # are defined before the preprocessor is started (similar to the -D option of # gcc). The argument of the tag is a list of macros of the form: name # or name=definition (no spaces). If the definition and the = are -# omitted =1 is assumed. +# omitted =1 is assumed. To prevent a macro definition from being +# undefined via #undef or recursively expanded use the := operator +# instead of the = operator. PREDEFINED = -# If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then # this tag can be used to specify a list of macro names that should be expanded. # The macro definition that is found in the sources will be used. # Use the PREDEFINED tag if you want to use a different macro definition. @@ -733,16 +998,30 @@ EXPAND_AS_DEFINED = # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then # doxygen's preprocessor will remove all function-like macros that are alone -# on a line and do not end with a semicolon. Such function macros are typically -# used for boiler-plate code, and will confuse the parser if not removed. +# on a line, have an all uppercase name, and do not end with a semicolon. Such +# function macros are typically used for boiler-plate code, and will confuse +# the parser if not removed. SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- -# Configuration::addtions related to external references +# Configuration::additions related to external references #--------------------------------------------------------------------------- -# The TAGFILES tag can be used to specify one or more tagfiles. +# The TAGFILES option can be used to specify one or more tagfiles. +# Optionally an initial location of the external documentation +# can be added for each tagfile. The format of a tag file without +# this location is as follows: +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths or +# URLs. If a location is present for each tag, the installdox tool +# does not have to be run to correct the links. +# Note that each tag file must have a unique name +# (where the name does NOT include the path) +# If a tag file is not located in the directory in which doxygen +# is run, you must also specify the path to the tagfile here. TAGFILES = @@ -773,13 +1052,20 @@ PERL_PATH = /usr/bin/perl #--------------------------------------------------------------------------- # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will -# generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or -# super classes. Setting the tag to NO turns the diagrams off. Note that this -# option is superceded by the HAVE_DOT option below. This is only a fallback. It is -# recommended to install and use dot, since it yield more powerful graphs. +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base +# or super classes. Setting the tag to NO turns the diagrams off. Note that +# this option is superseded by the HAVE_DOT option below. This is only a +# fallback. It is recommended to install and use dot, since it yields more +# powerful graphs. CLASS_DIAGRAMS = YES +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented +# or is not a class. + +HIDE_UNDOC_RELATIONS = YES + # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is # available from the path. This tool is part of Graphviz, a graph visualization # toolkit from AT&T and Lucent Bell Labs. The other options in this section @@ -801,17 +1087,22 @@ CLASS_GRAPH = YES COLLABORATION_GRAPH = YES +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for groups, showing the direct groups dependencies + +GROUP_GRAPHS = YES + +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. + +UML_LOOK = NO + # If set to YES, the inheritance and collaboration graphs will show the # relations between templates and their instances. TEMPLATE_RELATIONS = YES -# If set to YES, the inheritance and collaboration graphs will hide -# inheritance and usage relations if the target is undocumented -# or is not a class. - -HIDE_UNDOC_RELATIONS = YES - # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT # tags are set to YES then doxygen will generate a graph for each documented # file showing the direct and indirect include dependencies of the file with @@ -826,19 +1117,34 @@ INCLUDE_GRAPH = YES INCLUDED_BY_GRAPH = YES +# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will +# generate a call dependency graph for every global function or class method. +# Note that enabling this option will significantly increase the time of a run. +# So in most cases it will be better to enable call graphs for selected +# functions only using the \callgraph command. + +CALL_GRAPH = NO + # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen # will graphical hierarchy of all classes instead of a textual one. GRAPHICAL_HIERARCHY = YES +# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES +# then doxygen will show the dependencies a directory has on other directories +# in a graphical way. The dependency relations are determined by the #include +# relations between the files in the directories. + +DIRECTORY_GRAPH = YES + # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images -# generated by dot. Possible values are gif, jpg, and png -# If left blank gif will be used. +# generated by dot. Possible values are png, jpg, or gif +# If left blank png will be used. DOT_IMAGE_FORMAT = gif # The tag DOT_PATH can be used to specify the path where the dot tool can be -# found. If left blank, it is assumed the dot tool can be found on the path. +# found. If left blank, it is assumed the dot tool can be found in the path. DOT_PATH = @@ -864,6 +1170,33 @@ MAX_DOT_GRAPH_WIDTH = 1024 MAX_DOT_GRAPH_HEIGHT = 1024 +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes +# that lay further from the root node will be omitted. Note that setting this +# option to 1 or 2 may greatly reduce the computation time needed for large +# code bases. Also note that a graph may be further truncated if the graph's +# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH +# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), +# the graph is not depth-constrained. + +MAX_DOT_GRAPH_DEPTH = 0 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is disabled by default, which results in a white background. +# Warning: Depending on the platform used, enabling this option may lead to +# badly anti-aliased labels on the edges of a graph (i.e. they become hard to +# read). + +DOT_TRANSPARENT = NO + +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) +# support this, this feature is disabled by default. + +DOT_MULTI_TARGETS = NO + # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will # generate a legend page explaining the meaning of the various boxes and # arrows in the dot generated graphs. @@ -871,51 +1204,16 @@ MAX_DOT_GRAPH_HEIGHT = 1024 GENERATE_LEGEND = YES # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will -# remove the intermedate dot files that are used to generate +# remove the intermediate dot files that are used to generate # the various graphs. DOT_CLEANUP = YES #--------------------------------------------------------------------------- -# Configuration::addtions related to the search engine +# Configuration::additions related to the search engine #--------------------------------------------------------------------------- # The SEARCHENGINE tag specifies whether or not a search engine should be # used. If set to NO the values of all tags below this one will be ignored. SEARCHENGINE = NO - -# The CGI_NAME tag should be the name of the CGI script that -# starts the search engine (doxysearch) with the correct parameters. -# A script with this name will be generated by doxygen. - -CGI_NAME = search.cgi - -# The CGI_URL tag should be the absolute URL to the directory where the -# cgi binaries are located. See the documentation of your http daemon for -# details. - -CGI_URL = - -# The DOC_URL tag should be the absolute URL to the directory where the -# documentation is located. If left blank the absolute path to the -# documentation, with file:// prepended to it, will be used. - -DOC_URL = - -# The DOC_ABSPATH tag should be the absolute path to the directory where the -# documentation is located. If left blank the directory on the local machine -# will be used. - -DOC_ABSPATH = - -# The BIN_ABSPATH tag must point to the directory where the doxysearch binary -# is installed. - -BIN_ABSPATH = /usr/local/bin/ - -# The EXT_DOC_PATHS tag can be used to specify one or more paths to -# documentation generated for other projects. This allows doxysearch to search -# the documentation for these projects as well. - -EXT_DOC_PATHS = diff --git a/include/speex/speex.h b/include/speex/speex.h index f55bc30..0eb2b8a 100644 --- a/include/speex/speex.h +++ b/include/speex/speex.h @@ -94,10 +94,10 @@ extern "C" { /** Get current bit-rate used by the encoder or decoder */ #define SPEEX_GET_BITRATE 19 -/**Define a handler function for in-band Speex request*/ +/** Define a handler function for in-band Speex request*/ #define SPEEX_SET_HANDLER 20 -/**Define a handler function for in-band user-defined request*/ +/** Define a handler function for in-band user-defined request*/ #define SPEEX_SET_USER_HANDLER 22 /** Set sampling rate used in bit-rate computation */ @@ -129,7 +129,7 @@ extern "C" { /** Set submode encoding in each frame (1 for yes, 0 for no, setting to no breaks the standard) */ #define SPEEX_SET_SUBMODE_ENCODING 36 -/** */ +/** Get submode encoding in each frame */ #define SPEEX_GET_SUBMODE_ENCODING 37 /*#define SPEEX_SET_LOOKAHEAD 38*/ @@ -170,10 +170,15 @@ extern "C" { +/** Get major Speex version */ #define SPEEX_LIB_GET_MAJOR_VERSION 1 +/** Get minor Speex version */ #define SPEEX_LIB_GET_MINOR_VERSION 3 +/** Get micro Speex version */ #define SPEEX_LIB_GET_MICRO_VERSION 5 +/** Get extra Speex version */ #define SPEEX_LIB_GET_EXTRA_VERSION 7 +/** Get Speex version string */ #define SPEEX_LIB_GET_VERSION_STRING 9 /*#define SPEEX_LIB_SET_ALLOC_FUNC 10 diff --git a/include/speex/speex_echo.h b/include/speex/speex_echo.h index e1226cc..639cba3 100644 --- a/include/speex/speex_echo.h +++ b/include/speex/speex_echo.h @@ -1,8 +1,9 @@ -/* Copyright (C) Jean-Marc Valin - - File: speex_echo.h - - +/* Copyright (C) Jean-Marc Valin */ +/** + @file speex_echo.h + @brief Echo cancellation +*/ +/* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: @@ -39,6 +40,7 @@ extern "C" { struct drft_lookup; +/** Speex echo cancellation state. */ typedef struct SpeexEchoState { int frame_size; /**< Number of samples processed each time */ int window_size; diff --git a/include/speex/speex_jitter.h b/include/speex/speex_jitter.h index 0099cc1..ea46aa2 100644 --- a/include/speex/speex_jitter.h +++ b/include/speex/speex_jitter.h @@ -1,8 +1,9 @@ -/* Copyright (C) 2002 Jean-Marc Valin - File: speex_jitter.h - - Adaptive jitter buffer for Speex - +/* Copyright (C) 2002 Jean-Marc Valin */ +/** + @file speex_jitter.h + @brief Adaptive jitter buffer for Speex +*/ +/* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: @@ -42,41 +43,47 @@ extern "C" { #endif -#define SPEEX_JITTER_MAX_PACKET_SIZE 1500 -#define SPEEX_JITTER_MAX_BUFFER_SIZE 20 +#define SPEEX_JITTER_MAX_PACKET_SIZE 1500 /**< Maximum number of bytes per packet */ +#define SPEEX_JITTER_MAX_BUFFER_SIZE 20 /**< Maximum number of packets in jitter buffer */ -#define MAX_MARGIN 12 +#define MAX_MARGIN 12 /**< Number of bins in margin histogram */ +/** Speex jitter-buffer state. */ typedef struct SpeexJitter { - int buffer_size; - int pointer_timestamp; + int buffer_size; /**< Buffer size */ + int pointer_timestamp; /**< Pointer timestamp */ - SpeexBits current_packet; - int valid_bits; + SpeexBits current_packet; /**< Current Speex packet */ + int valid_bits; /**< True if Speex bits are valid */ - char buf[SPEEX_JITTER_MAX_BUFFER_SIZE][SPEEX_JITTER_MAX_PACKET_SIZE]; - int timestamp[SPEEX_JITTER_MAX_BUFFER_SIZE]; - int len[SPEEX_JITTER_MAX_BUFFER_SIZE]; + char buf[SPEEX_JITTER_MAX_BUFFER_SIZE][SPEEX_JITTER_MAX_PACKET_SIZE]; /**< Buffer of packets */ + int timestamp[SPEEX_JITTER_MAX_BUFFER_SIZE]; /**< Timestamp of packet */ + int len[SPEEX_JITTER_MAX_BUFFER_SIZE]; /**< Number of bytes in packet */ - void *dec; - int frame_size; - int frame_time; - int reset_state; + void *dec; /**< Pointer to Speex decoder */ + int frame_size; /**< Frame size of Speex decoder */ + int frame_time; /**< Frame time in [ms] of Speex decoder */ + int reset_state; /**< True if Speex state was reset */ - int lost_count; - float shortterm_margin[MAX_MARGIN]; - float longterm_margin[MAX_MARGIN]; - float loss_rate; + int lost_count; /**< Number of lost packets */ + float shortterm_margin[MAX_MARGIN]; /**< Short term margins */ + float longterm_margin[MAX_MARGIN]; /**< Long term margins */ + float loss_rate; /**< Loss rate */ } SpeexJitter; +/** Initialise jitter buffer */ void speex_jitter_init(SpeexJitter *jitter, void *decoder, int sampling_rate); +/** Destroy jitter buffer */ void speex_jitter_destroy(SpeexJitter *jitter); +/** Put one packet into the jitter buffer */ void speex_jitter_put(SpeexJitter *jitter, char *packet, int len, int time); +/** Get on packet from the jitter buffer */ void speex_jitter_get(SpeexJitter *jitter, short *out, int *current_timestamp); +/** Get pointer timestamp of jitter buffer */ int speex_jitter_get_pointer_timestamp(SpeexJitter *jitter); #ifdef __cplusplus diff --git a/include/speex/speex_preprocess.h b/include/speex/speex_preprocess.h index 75f86dc..456e064 100644 --- a/include/speex/speex_preprocess.h +++ b/include/speex/speex_preprocess.h @@ -1,9 +1,10 @@ -/* Copyright (C) 2003 Epic Games - Written by Jean-Marc Valin - - File: speex_preprocess.h - - +/* Copyright (C) 2003 Epic Games + Written by Jean-Marc Valin */ +/** + @file speex_preprocess.h + @brief Speex preprocessor +*/ +/* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: @@ -42,6 +43,7 @@ extern "C" { struct drft_lookup; +/** Speex pre-processor state. */ typedef struct SpeexPreprocessState { int frame_size; /**< Number of samples processed each time */ int ps_size; /**< Number of points in the power spectrum */ @@ -119,25 +121,39 @@ int speex_preprocess_ctl(SpeexPreprocessState *st, int request, void *ptr); +/** Set preprocessor denoiser state */ #define SPEEX_PREPROCESS_SET_DENOISE 0 +/** Get preprocessor denoiser state */ #define SPEEX_PREPROCESS_GET_DENOISE 1 +/** Set preprocessor Automatic Gain Control state */ #define SPEEX_PREPROCESS_SET_AGC 2 +/** Get preprocessor Automatic Gain Control state */ #define SPEEX_PREPROCESS_GET_AGC 3 +/** Set preprocessor Voice Activity Detection state */ #define SPEEX_PREPROCESS_SET_VAD 4 +/** Get preprocessor Voice Activity Detection state */ #define SPEEX_PREPROCESS_GET_VAD 5 +/** Set preprocessor Automatic Gain Control level */ #define SPEEX_PREPROCESS_SET_AGC_LEVEL 6 +/** Get preprocessor Automatic Gain Control level */ #define SPEEX_PREPROCESS_GET_AGC_LEVEL 7 +/** Set preprocessor dereverb state */ #define SPEEX_PREPROCESS_SET_DEREVERB 8 +/** Get preprocessor dereverb state */ #define SPEEX_PREPROCESS_GET_DEREVERB 9 +/** Set preprocessor dereverb level */ #define SPEEX_PREPROCESS_SET_DEREVERB_LEVEL 10 +/** Get preprocessor dereverb level */ #define SPEEX_PREPROCESS_GET_DEREVERB_LEVEL 11 +/** Set preprocessor dereverb decay */ #define SPEEX_PREPROCESS_SET_DEREVERB_DECAY 12 +/** Get preprocessor dereverb decay */ #define SPEEX_PREPROCESS_GET_DEREVERB_DECAY 13 #ifdef __cplusplus diff --git a/include/speex/speex_types.h b/include/speex/speex_types.h index cde64e6..cbf6c0e 100644 --- a/include/speex/speex_types.h +++ b/include/speex/speex_types.h @@ -15,6 +15,10 @@ last mod: $Id: os_types.h 7524 2004-08-11 04:20:36Z conrad $ ********************************************************************/ +/** + @file speex_types.h + @brief Speex types +*/ #ifndef _SPEEX_TYPES_H #define _SPEEX_TYPES_H diff --git a/libspeex/arch.h b/libspeex/arch.h index 65ceb22..b476244 100644 --- a/libspeex/arch.h +++ b/libspeex/arch.h @@ -37,10 +37,10 @@ #include "speex/speex_types.h" -#define ABS(x) ((x) < 0 ? (-(x)) : (x)) -#define ABS16(x) ((x) < 0 ? (-(x)) : (x)) -#define MAX16(a,b) ((a) > (b) ? (a) : (b)) -#define ABS32(x) ((x) < 0 ? (-(x)) : (x)) +#define ABS(x) ((x) < 0 ? (-(x)) : (x)) /**< Absolute integer value. */ +#define ABS16(x) ((x) < 0 ? (-(x)) : (x)) /**< Absolute 16-bit value. */ +#define MAX16(a,b) ((a) > (b) ? (a) : (b)) /**< Maximum 16-bit value. */ +#define ABS32(x) ((x) < 0 ? (-(x)) : (x)) /**< Absolute 32-bit value. */ #ifdef FIXED_POINT diff --git a/libspeex/cb_search.h b/libspeex/cb_search.h index 107d5ef..38ac077 100644 --- a/libspeex/cb_search.h +++ b/libspeex/cb_search.h @@ -1,7 +1,9 @@ -/* Copyright (C) 2002 Jean-Marc Valin & David Rowe - File: cb_search.h - Overlapped codebook search - +/* Copyright (C) 2002 Jean-Marc Valin & David Rowe */ +/** + @file cb_search.h + @brief Overlapped codebook search +*/ +/* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: @@ -36,6 +38,7 @@ #include <speex/speex_bits.h> #include "misc.h" +/** Split codebook parameters. */ typedef struct split_cb_params { int subvect_size; int nb_subvect; @@ -46,11 +49,11 @@ typedef struct split_cb_params { void split_cb_search_shape_sign( -spx_sig_t target[], /* target vector */ -spx_coef_t ak[], /* LPCs for this subframe */ -spx_coef_t awk1[], /* Weighted LPCs for this subframe */ -spx_coef_t awk2[], /* Weighted LPCs for this subframe */ -const void *par, /* Codebook/search parameters*/ +spx_sig_t target[], /* target vector */ +spx_coef_t ak[], /* LPCs for this subframe */ +spx_coef_t awk1[], /* Weighted LPCs for this subframe */ +spx_coef_t awk2[], /* Weighted LPCs for this subframe */ +const void *par, /* Codebook/search parameters */ int p, /* number of LPC coeffs */ int nsf, /* number of samples in subframe */ spx_sig_t *exc, @@ -63,7 +66,7 @@ int update_target void split_cb_shape_sign_unquant( spx_sig_t *exc, -const void *par, /* non-overlapping codebook */ +const void *par, /* non-overlapping codebook */ int nsf, /* number of samples in subframe */ SpeexBits *bits, char *stack @@ -71,11 +74,11 @@ char *stack void noise_codebook_quant( -spx_sig_t target[], /* target vector */ -spx_coef_t ak[], /* LPCs for this subframe */ -spx_coef_t awk1[], /* Weighted LPCs for this subframe */ -spx_coef_t awk2[], /* Weighted LPCs for this subframe */ -const void *par, /* Codebook/search parameters*/ +spx_sig_t target[], /* target vector */ +spx_coef_t ak[], /* LPCs for this subframe */ +spx_coef_t awk1[], /* Weighted LPCs for this subframe */ +spx_coef_t awk2[], /* Weighted LPCs for this subframe */ +const void *par, /* Codebook/search parameters */ int p, /* number of LPC coeffs */ int nsf, /* number of samples in subframe */ spx_sig_t *exc, @@ -89,7 +92,7 @@ int update_target void noise_codebook_unquant( spx_sig_t *exc, -const void *par, /* non-overlapping codebook */ +const void *par, /* non-overlapping codebook */ int nsf, /* number of samples in subframe */ SpeexBits *bits, char *stack diff --git a/libspeex/cb_search_arm4.h b/libspeex/cb_search_arm4.h index 56cbb19..71318ba 100644 --- a/libspeex/cb_search_arm4.h +++ b/libspeex/cb_search_arm4.h @@ -1,6 +1,9 @@ -/* Copyright (C) 2004 Jean-Marc Valin - File: cb_search.c (ARM4 version) - +/* Copyright (C) 2004 Jean-Marc Valin */ +/** + @file cb_search_arm4.h + @brief Fixed codebook functions (ARM4 version) +*/ +/* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: diff --git a/libspeex/cb_search_bfin.h b/libspeex/cb_search_bfin.h index 8412b4b..7d476a3 100644 --- a/libspeex/cb_search_bfin.h +++ b/libspeex/cb_search_bfin.h @@ -1,8 +1,10 @@ -/* Copyright (C) 2005 Analog Devices - Author: Jean-Marc Valin - File: cb_search_bfin.h - Fixed codebook functions (Blackfin version) - +/* Copyright (C) 2005 Analog Devices */ +/** + @author Jean-Marc Valin + @file cb_search_bfin.h + @brief Fixed codebook functions (Blackfin version) +*/ +/* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: diff --git a/libspeex/cb_search_sse.h b/libspeex/cb_search_sse.h index 2ca3c7c..8b03968 100644 --- a/libspeex/cb_search_sse.h +++ b/libspeex/cb_search_sse.h @@ -1,6 +1,9 @@ -/* Copyright (C) 2004 Jean-Marc Valin - File: cb_search.c (SSE version) - +/* Copyright (C) 2004 Jean-Marc Valin */ +/** + @file cb_search_sse.h + @brief Fixed codebook functions (SSE version) +*/ +/* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: diff --git a/libspeex/filters.h b/libspeex/filters.h index de0b284..c86d189 100644 --- a/libspeex/filters.h +++ b/libspeex/filters.h @@ -1,7 +1,9 @@ -/* Copyright (C) 2002 Jean-Marc Valin - File: filters.h - Various analysis/synthesis filters - +/* Copyright (C) 2002 Jean-Marc Valin */ +/** + @file filters.h + @brief Various analysis/synthesis filters +*/ +/* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: @@ -45,7 +47,8 @@ int normalize16(const spx_sig_t *x, spx_word16_t *y, spx_sig_t max_scale, int le #endif -typedef struct CombFilterMem { +/** Combined filter memory. */ +typedef struct { int last_pitch; spx_word16_t last_pitch_gain[3]; spx_word16_t smooth_gain; diff --git a/libspeex/filters_arm4.h b/libspeex/filters_arm4.h index 7cdb25a..b250364 100644 --- a/libspeex/filters_arm4.h +++ b/libspeex/filters_arm4.h @@ -1,7 +1,9 @@ -/* Copyright (C) 2004 Jean-Marc Valin - File: filters_arm4.h - ARM4-optimized filtering routines - +/* Copyright (C) 2004 Jean-Marc Valin */ +/** + @file filters_arm4.h + @brief Various analysis/synthesis filters (ARM4 version) +*/ +/* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: diff --git a/libspeex/filters_bfin.h b/libspeex/filters_bfin.h index 4604d71..f968722 100644 --- a/libspeex/filters_bfin.h +++ b/libspeex/filters_bfin.h @@ -1,8 +1,9 @@ -/* Copyright (C) 2005 Analog Devices - Author: Jean-Marc Valin - File: filters_bfin.h - Various analysis/synthesis filters (Blackfin version) - +/* Copyright (C) 2005 Analog Devices */ +/** + @file filters_bfin.h + @brief Various analysis/synthesis filters (Blackfin version) +*/ +/* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: diff --git a/libspeex/filters_sse.h b/libspeex/filters_sse.h index 1a9896c..82cde0d 100644 --- a/libspeex/filters_sse.h +++ b/libspeex/filters_sse.h @@ -1,7 +1,9 @@ -/* Copyright (C) 2002 Jean-Marc Valin - File: filters.c - Various analysis/synthesis filters - +/* Copyright (C) 2002 Jean-Marc Valin */ +/** + @file filters_sse.h + @brief Various analysis/synthesis filters (SSE version) +*/ +/* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: diff --git a/libspeex/fixed_arm5e.h b/libspeex/fixed_arm5e.h index a060b58..9b4861c 100644 --- a/libspeex/fixed_arm5e.h +++ b/libspeex/fixed_arm5e.h @@ -1,6 +1,6 @@ /* Copyright (C) 2003 Jean-Marc Valin */ /** - @file fixed_generic.h + @file fixed_arm5e.h @brief ARM-tuned fixed-point operations */ /* diff --git a/libspeex/lpc.h b/libspeex/lpc.h index 6050447..d64df96 100644 --- a/libspeex/lpc.h +++ b/libspeex/lpc.h @@ -1,7 +1,9 @@ -/* Copyright (C) 2002 Jean-Marc Valin - File: lpc.h - Functions for LPC (Linear Prediction Coefficients) analysis - +/* Copyright (C) 2002 Jean-Marc Valin */ +/** + @file lpc.h + @brief Functions for LPC (Linear Prediction Coefficients) analysis +*/ +/* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: diff --git a/libspeex/lpc_bfin.h b/libspeex/lpc_bfin.h index cfd5fe5..19c7313 100644 --- a/libspeex/lpc_bfin.h +++ b/libspeex/lpc_bfin.h @@ -1,8 +1,10 @@ -/* Copyright (C) 2005 Analog Devices - Author: Jean-Marc Valin - File: lpc_bfin.h - LPC stuff (Blackfin version) - +/* Copyright (C) 2005 Analog Devices */ +/** + @file lpc_bfin.h + @author Jean-Marc Valin + @brief Functions for LPC (Linear Prediction Coefficients) analysis (Blackfin version) +*/ +/* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: diff --git a/libspeex/lsp.h b/libspeex/lsp.h index 5e7b02a..9d0345f 100644 --- a/libspeex/lsp.h +++ b/libspeex/lsp.h @@ -14,6 +14,10 @@ Modified by Jean-Marc Valin unit circle.
\*---------------------------------------------------------------------------*/
+/**
+ @file lsp.h
+ @brief Line Spectral Pair (LSP) functions.
+*/
/* Speex License:
Redistribution and use in source and binary forms, with or without
diff --git a/libspeex/ltp.h b/libspeex/ltp.h index 9895356..36debbd 100644 --- a/libspeex/ltp.h +++ b/libspeex/ltp.h @@ -1,7 +1,9 @@ -/* Copyright (C) 2002 Jean-Marc Valin - File: ltp.h - Long-Term Prediction functions - +/* Copyright (C) 2002 Jean-Marc Valin */ +/** + @file ltp.h + @brief Long-Term Prediction functions +*/ +/* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: @@ -33,7 +35,8 @@ #include <speex/speex_bits.h> #include "misc.h" -typedef struct ltp_params { +/** LTP parameters. */ +typedef struct { const signed char *gain_cdbk; int gain_bits; int pitch_bits; diff --git a/libspeex/ltp_arm4.h b/libspeex/ltp_arm4.h index 6f458ea..a5a0bee 100644 --- a/libspeex/ltp_arm4.h +++ b/libspeex/ltp_arm4.h @@ -1,7 +1,9 @@ -/* Copyright (C) 2004 Jean-Marc Valin - File: ltp.c - Lont-Term Prediction functions (SSE version) - +/* Copyright (C) 2004 Jean-Marc Valin */ +/** + @file ltp_arm4.h + @brief Long-Term Prediction functions (ARM4 version) +*/ +/* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: diff --git a/libspeex/ltp_bfin.h b/libspeex/ltp_bfin.h index a800503..70bff7e 100644 --- a/libspeex/ltp_bfin.h +++ b/libspeex/ltp_bfin.h @@ -1,8 +1,10 @@ -/* Copyright (C) 2005 Analog Devices - Author: Jean-Marc Valin - File: ltp_bfin.h - Long-Term Prediction functions (Blackfin version) - +/* Copyright (C) 2005 Analog Devices */ +/** + @file ltp_bfin.h + @author Jean-Marc Valin + @brief Long-Term Prediction functions (Blackfin version) +*/ +/* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: diff --git a/libspeex/ltp_sse.h b/libspeex/ltp_sse.h index 0267883..94c0012 100644 --- a/libspeex/ltp_sse.h +++ b/libspeex/ltp_sse.h @@ -1,7 +1,9 @@ -/* Copyright (C) 2002 Jean-Marc Valin - File: ltp.c - Lont-Term Prediction functions (SSE version) - +/* Copyright (C) 2002 Jean-Marc Valin */ +/** + @file ltp_sse.h + @brief Long-Term Prediction functions (SSE version) +*/ +/* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: diff --git a/libspeex/math_approx.h b/libspeex/math_approx.h index 1c84f5c..e489d09 100644 --- a/libspeex/math_approx.h +++ b/libspeex/math_approx.h @@ -1,7 +1,9 @@ -/* Copyright (C) 2002 Jean-Marc Valin - File: math_approx.c - Various math approximation functions for Speex - +/* Copyright (C) 2002 Jean-Marc Valin */ +/** + @file math_approx.h + @brief Various math approximation functions for Speex +*/ +/* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: diff --git a/libspeex/medfilter.h b/libspeex/medfilter.h index e34065b..718869c 100644 --- a/libspeex/medfilter.h +++ b/libspeex/medfilter.h @@ -1,8 +1,9 @@ -/* Copyright (C) 2004 Jean-Marc Valin - File medfilter.h - Median filter - - +/* Copyright (C) 2004 Jean-Marc Valin */ +/** + @file medfilter.h + @brief Median filter +*/ +/* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: @@ -35,6 +36,7 @@ #ifndef MEDFILTER_H #define MEDFILTER_H +/** Median filter. */ typedef struct { int N; int filled; diff --git a/libspeex/misc.c b/libspeex/misc.c index 4b0223b..fd78d0b 100644 --- a/libspeex/misc.c +++ b/libspeex/misc.c @@ -1,5 +1,5 @@ /* Copyright (C) 2002-2005 Jean-Marc Valin - File: mics.c + File: misc.c Various utility routines for Speex Redistribution and use in source and binary forms, with or without diff --git a/libspeex/misc.h b/libspeex/misc.h index 8232ebd..8e83d21 100644 --- a/libspeex/misc.h +++ b/libspeex/misc.h @@ -36,20 +36,23 @@ #define MISC_H #ifndef SPEEX_VERSION -#define SPEEX_MAJOR_VERSION 1 -#define SPEEX_MINOR_VERSION 1 -#define SPEEX_MICRO_VERSION 10 -#define SPEEX_EXTRA_VERSION "" -#define SPEEX_VERSION "speex-1.1.10" +#define SPEEX_MAJOR_VERSION 1 /**< Major Speex version. */ +#define SPEEX_MINOR_VERSION 1 /**< Minor Speex version. */ +#define SPEEX_MICRO_VERSION 10 /**< Micro Speex version. */ +#define SPEEX_EXTRA_VERSION "" /**< Extra Speex version. */ +#define SPEEX_VERSION "speex-1.1.10" /**< Speex version string. */ #endif #include "arch.h" #ifndef RELEASE +/** Print a named vector to stdout */ void print_vec(float *vec, int len, char *name); #endif +/** Convert big endian */ spx_uint32_t be_int(spx_uint32_t i); +/** Convert little endian */ spx_uint32_t le_int(spx_uint32_t i); /** Speex wrapper for calloc. To do your own dynamic allocation, all you need to do is replace this function, speex_realloc and speex_free */ @@ -70,19 +73,28 @@ void speex_free_scratch (void *ptr); /** Speex wrapper for mem_move */ void *speex_move (void *dest, void *src, int n); +/** Speex wrapper for memcpy */ void speex_memcpy_bytes(char *dst, char *src, int nbytes); + +/** Speex wrapper for memset */ void speex_memset_bytes(char *dst, char src, int nbytes); +/** Print error message to stderr */ void speex_error(const char *str); +/** Print warning message to stderr */ void speex_warning(const char *str); +/** Print warning message with integer argument to stderr */ void speex_warning_int(const char *str, int val); +/** Generate a vector of random numbers */ void speex_rand_vec(float std, spx_sig_t *data, int len); +/** Generate a random number */ spx_word32_t speex_rand(spx_word16_t std, spx_int32_t *seed); +/** Speex wrapper for putc */ void _speex_putc(int ch, void *file); #endif diff --git a/libspeex/misc_bfin.h b/libspeex/misc_bfin.h index f0a08dd..77b082c 100644 --- a/libspeex/misc_bfin.h +++ b/libspeex/misc_bfin.h @@ -1,8 +1,10 @@ -/* Copyright (C) 2005 Analog Devices - Author: Jean-Marc Valin - File: mics_bfin.h - Various utility routines for Speex - +/* Copyright (C) 2005 Analog Devices */ +/** + @file misc_bfin.h + @author Jean-Marc Valin + @brief Various compatibility routines for Speex (Blackfin version) +*/ +/* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: diff --git a/libspeex/quant_lsp.h b/libspeex/quant_lsp.h index dc2828e..c6d5bb3 100644 --- a/libspeex/quant_lsp.h +++ b/libspeex/quant_lsp.h @@ -1,7 +1,9 @@ -/* Copyright (C) 2002 Jean-Marc Valin - File: quant_lsp.h - LSP vector quantization - +/* Copyright (C) 2002 Jean-Marc Valin */ +/** + @file quant_lsp.h + @brief LSP vector quantization +*/ +/* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: diff --git a/libspeex/smallft.h b/libspeex/smallft.h index c87389c..446e2f6 100644 --- a/libspeex/smallft.h +++ b/libspeex/smallft.h @@ -14,16 +14,20 @@ last mod: $Id: smallft.h,v 1.3 2003/09/16 18:35:45 jm Exp $ ********************************************************************/ +/** + @file smallft.h + @brief Discrete Rotational Fourier Transform (DRFT) +*/ #ifndef _V_SMFT_H_ #define _V_SMFT_H_ -/*#include "vorbis/codec.h"*/ #ifdef __cplusplus extern "C" { #endif +/** Discrete Rotational Fourier Transform lookup */ struct drft_lookup{ int n; float *trigcache; diff --git a/libspeex/stack_alloc.h b/libspeex/stack_alloc.h index 9d18468..39f5611 100644 --- a/libspeex/stack_alloc.h +++ b/libspeex/stack_alloc.h @@ -1,8 +1,9 @@ -/* Copyright (C) 2002 Jean-Marc Valin - File: stack_alloc.h - - Temporary memory allocation on stack - +/* Copyright (C) 2002 Jean-Marc Valin */ +/** + @file stack_alloc.h + @brief Temporary memory allocation on stack +*/ +/* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: @@ -38,28 +39,68 @@ #include <alloca.h> #endif +/** + * @def ALIGN(stack, size) + * + * Aligns the stack to a 'size' boundary + * + * @param stack Stack + * @param size New size boundary + */ + +/** + * @def PUSH(stack, size, type) + * + * Allocates 'size' elements of type 'type' on the stack + * + * @param stack Stack + * @param size Number of elements + * @param type Type of element + */ + +/** + * @def PUSHS(stack, type) + * + * Allocates a struct stack + * + * @param stack Stack + * @param type Struct type + */ + +/** + * @def VARDECL(var) + * + * Declare variable on stack + * + * @param var Variable to declare + */ + +/** + * @def ALLOC(var, size, type) + * + * Allocate 'size' elements of 'type' on stack + * + * @param var Name of variable to allocate + * @param size Number of elements + * @param type Type of element + */ + #ifdef ENABLE_VALGRIND #include <valgrind/memcheck.h> -/*Aligns the stack to a 'size' boundary */ + #define ALIGN(stack, size) ((stack) += ((size) - (long)(stack)) & ((size) - 1)) -/* Allocates 'size' elements of type 'type' on the stack */ #define PUSH(stack, size, type) (VALGRIND_MAKE_NOACCESS(stack, 1000),ALIGN((stack),sizeof(type)),VALGRIND_MAKE_WRITABLE(stack, ((size)*sizeof(type))),(stack)+=((size)*sizeof(type)),(type*)((stack)-((size)*sizeof(type)))) -/* Allocates a struct stack */ #define PUSHS(stack, type) (VALGRIND_MAKE_NOACCESS(stack, 1000),ALIGN((stack),sizeof(long)),VALGRIND_MAKE_WRITABLE(stack, (sizeof(type))),(stack)+=(sizeof(type)),(type*)((stack)-(sizeof(type)))) #else - -/*Aligns the stack to a 'size' boundary */ #define ALIGN(stack, size) ((stack) += ((size) - (long)(stack)) & ((size) - 1)) -/* Allocates 'size' elements of type 'type' on the stack */ #define PUSH(stack, size, type) (ALIGN((stack),sizeof(type)),(stack)+=((size)*sizeof(type)),(type*)((stack)-((size)*sizeof(type)))) -/* Allocates a struct stack */ #define PUSHS(stack, type) (ALIGN((stack),sizeof(long)),(stack)+=(sizeof(type)),(type*)((stack)-(sizeof(type)))) #endif diff --git a/libspeex/vbr.h b/libspeex/vbr.h index 7a6abef..34e1d4c 100644 --- a/libspeex/vbr.h +++ b/libspeex/vbr.h @@ -1,8 +1,9 @@ -/* Copyright (C) 2002 Jean-Marc Valin - File: vbr.h - - VBR-related routines - +/* Copyright (C) 2002 Jean-Marc Valin */ +/** + @file vbr.h + @brief Variable Bit-Rate (VBR) related routines +*/ +/* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: @@ -44,6 +45,7 @@ extern const float vbr_nb_thresh[9][11]; extern const float vbr_hb_thresh[5][11]; extern const float vbr_uhb_thresh[2][11]; +/** VBR state. */ typedef struct VBRState { float energy_alpha; float average_energy; diff --git a/libspeex/vq.h b/libspeex/vq.h index 79bd9e9..7ca8197 100644 --- a/libspeex/vq.h +++ b/libspeex/vq.h @@ -1,7 +1,9 @@ -/* Copyright (C) 2002 Jean-Marc Valin - File: vq.h - Vector quantization - +/* Copyright (C) 2002 Jean-Marc Valin */ +/** + @file vq.h + @brief Vector quantization +*/ +/* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: diff --git a/libspeex/vq_arm4.h b/libspeex/vq_arm4.h index 3b11665..585b861 100644 --- a/libspeex/vq_arm4.h +++ b/libspeex/vq_arm4.h @@ -1,7 +1,9 @@ -/* Copyright (C) 2004 Jean-Marc Valin - File: vq_arm4.h - ARM4-optimized vq routine - +/* Copyright (C) 2004 Jean-Marc Valin */ +/** + @file vq_arm4.h + @brief ARM4-optimized vq routine +*/ +/* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: @@ -110,4 +112,4 @@ dist1=dist2=dist3=dist4=0; } codebook += 3*len; } -}
\ No newline at end of file +} diff --git a/libspeex/vq_bfin.h b/libspeex/vq_bfin.h index 739062a..2cc9ea5 100644 --- a/libspeex/vq_bfin.h +++ b/libspeex/vq_bfin.h @@ -1,8 +1,10 @@ -/* Copyright (C) 2005 Analog Devices - Author: Jean-Marc Valin - File: vq_arm4.h - Blackfin-optimized vq routine - +/* Copyright (C) 2005 Analog Devices */ +/** + @file vq_bfin.h + @author Jean-Marc Valin + @brief Blackfin-optimized vq routine +*/ +/* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: diff --git a/libspeex/vq_sse.h b/libspeex/vq_sse.h index 61b5806..00a42ce 100644 --- a/libspeex/vq_sse.h +++ b/libspeex/vq_sse.h @@ -1,7 +1,9 @@ -/* Copyright (C) 2004 Jean-Marc Valin - File: vq_arm4.h - ARM4-optimized vq routine - +/* Copyright (C) 2004 Jean-Marc Valin */ +/** + @file vq_sse.h + @brief SSE-optimized vq routine +*/ +/* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: |