Doxygen-based API docs
authorMarko Kreen <markokr@gmail.com>
Wed, 13 Jan 2010 07:32:09 +0000 (09:32 +0200)
committerMarko Kreen <markokr@gmail.com>
Wed, 15 Sep 2010 12:00:12 +0000 (15:00 +0300)
29 files changed:
Makefile
doc/Doxyfile [new file with mode: 0644]
doc/mainpage.dox [new file with mode: 0644]
doc/setup.dox [new file with mode: 0644]
usual/aatree.h
usual/base.h
usual/cxalloc.c
usual/cxalloc.h
usual/daemon.h
usual/err.h
usual/hashtab-impl.h
usual/heap-impl.h
usual/list.h
usual/lookup3.h
usual/mbuf.h
usual/md5.h
usual/mempool.h
usual/pgutil.h
usual/pthread.h
usual/regex.h
usual/sha1.h
usual/shlist.h
usual/slab.c
usual/slab.h
usual/statlist.h
usual/string.h
usual/strpool.h
usual/time.h
usual/utf8.h

index 7f79a4f673e6775f4e2bbed48c84e1f06b5b8d4c..92aa984b1df3170fd56ca44a94f306cf36f61212 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -139,3 +139,6 @@ tgz: config.mak $(DISTFILES)
        tar czf $(FULL).tgz $(FULL)
        rm -rf $(FULL)
 
+dox:
+       doxygen doc/Doxyfile
+
diff --git a/doc/Doxyfile b/doc/Doxyfile
new file mode 100644 (file)
index 0000000..3b5bfed
--- /dev/null
@@ -0,0 +1,1551 @@
+# Doxyfile 1.6.3
+
+# This file describes the settings to be used by the documentation system
+# doxygen (www.doxygen.org) for a project
+#
+# All text after a hash (#) is considered a comment and will be ignored
+# The format is:
+#       TAG = value [value, ...]
+# For lists items can also be appended using:
+#       TAG += value [value, ...]
+# Values that contain spaces should be placed between quotes (" ")
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+
+# This tag specifies the encoding used for all characters in the config file
+# that follow. The default is UTF-8 which is also the encoding used for all
+# text before the first occurrence of this tag. Doxygen uses libiconv (or the
+# iconv built into libc) for the transcoding. See
+# http://www.gnu.org/software/libiconv for the list of possible encodings.
+
+DOXYFILE_ENCODING      = UTF-8
+
+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
+# by quotes) that should identify the project.
+
+PROJECT_NAME           = libusual
+
+# 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         = 0.1
+
+# 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
+
+# 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:
+# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
+# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
+# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
+# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
+# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
+# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
+
+OUTPUT_LANGUAGE        = English
+
+# 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        = YES
+
+# 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 regular Qt-style comments
+# (thus requiring an explicit @brief command for a brief description.)
+
+JAVADOC_AUTOBRIEF      = YES
+
+# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
+# interpret the first line (until the first dot) of a Qt-style
+# comment as the brief description. If set to NO, the comments
+# will behave just like regular Qt-style comments (thus requiring
+# an explicit \brief command for a brief description.)
+
+QT_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 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 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  = YES
+
+# 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 OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
+# sources only. Doxygen will then generate output that is more tailored for
+# Fortran.
+
+OPTIMIZE_FOR_FORTRAN   = NO
+
+# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
+# sources. Doxygen will then generate output that is tailored for
+# VHDL.
+
+OPTIMIZE_OUTPUT_VHDL   = NO
+
+# Doxygen selects the parser to use depending on the extension of the files it parses.
+# With this tag you can assign which parser to use for a given extension.
+# Doxygen has a built-in mapping, but you can override or extend it using this tag.
+# The format is ext=language, where ext is a file extension, and language is one of
+# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
+# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
+# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
+# use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
+
+EXTENSION_MAPPING      =
+
+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
+# to include (a tag file for) the STL sources as input, then you should
+# set this tag to YES in order to let doxygen match functions declarations and
+# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
+# func(std::string) {}). This also make the inheritance and collaboration
+# diagrams that involve STL classes more complete and accurate.
+
+BUILTIN_STL_SUPPORT    = NO
+
+# If you use Microsoft's C++/CLI language, you should set this option to YES to
+# enable parsing support.
+
+CPP_CLI_SUPPORT        = NO
+
+# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
+# Doxygen will parse them like normal C++ but will assume all classes use public
+# instead of private inheritance when no explicit protection keyword is present.
+
+SIP_SUPPORT            = NO
+
+# For Microsoft's IDL there are propget and propput attributes to indicate getter
+# and setter methods for a property. Setting this option to YES (the default)
+# will make doxygen to replace the get and set methods by a property in the
+# documentation. This will only work if the methods are indeed getting or
+# setting a simple type. If this is not the case, or you want to show the
+# methods anyway, you should set this option to NO.
+
+IDL_PROPERTY_SUPPORT   = 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
+
+# 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
+
+# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
+# is documented as struct, union, or enum with the name of the typedef. So
+# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
+# with name TypeT. When disabled the typedef will appear as a member of a file,
+# namespace, or class. And the struct will be named TypeS. This can typically
+# be useful for C code in case the coding convention dictates that all compound
+# types are typedef'ed and only the typedef is referenced, never the tag name.
+
+TYPEDEF_HIDES_STRUCT   = YES
+
+# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
+# determine which symbols to keep in memory and which to flush to disk.
+# When the cache is full, less often used symbols will be written to disk.
+# For small to medium size projects (<1000 input files) the default value is
+# probably good enough. For larger projects a too small cache size can cause
+# doxygen to be busy swapping symbols to and from disk most of the time
+# causing a significant performance penality.
+# If the system has enough physical memory increasing the cache will improve the
+# performance by keeping more symbols in memory. Note that the value works on
+# a logarithmic scale so increasing the size by one will rougly double the
+# memory usage. The cache size is given by this formula:
+# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
+# corresponding to a cache size of 2^16 = 65536 symbols
+
+SYMBOL_CACHE_SIZE      = 0
+
+#---------------------------------------------------------------------------
+# 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
+# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
+
+EXTRACT_ALL            = NO
+
+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
+# will be included in the documentation.
+
+EXTRACT_PRIVATE        = NO
+
+# If the EXTRACT_STATIC tag is set to YES all static members of a file
+# will be included in the documentation.
+
+EXTRACT_STATIC         = YES
+
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
+# defined locally in source files will be included in the documentation.
+# If set to NO only classes defined in header files are included.
+
+EXTRACT_LOCAL_CLASSES  = NO
+
+# 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 this flag is set to YES, the members of anonymous namespaces will be
+# extracted and appear in the documentation as a namespace called
+# 'anonymous_namespace{file}', where file will be replaced with the base
+# name of the file that contains the anonymous namespace. By default
+# anonymous namespace are hidden.
+
+EXTRACT_ANON_NSPACES   = 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
+# various overviews, but no documentation section is generated.
+# This option has no effect if EXTRACT_ALL is enabled.
+
+HIDE_UNDOC_MEMBERS     = YES
+
+# 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 classes will be included in the various
+# overviews. This option has no effect if EXTRACT_ALL is enabled.
+
+HIDE_UNDOC_CLASSES     = YES
+
+# 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.
+
+HIDE_FRIEND_COMPOUNDS  = 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.
+
+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
+# to NO (the default) then the documentation will be excluded.
+# Set it to YES to include the internal documentation.
+
+INTERNAL_DOCS          = NO
+
+# 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
+# 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
+# and Mac users are advised to set this option to NO.
+
+CASE_SENSE_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 SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
+# will put a list of the files that are included by a file in the documentation
+# of that file.
+
+SHOW_INCLUDE_FILES     = NO
+
+# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
+# will list include files with double quotes in the documentation
+# rather than with sharp brackets.
+
+FORCE_LOCAL_INCLUDES   = NO
+
+# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
+# is inserted in the documentation for inline members.
+
+INLINE_INFO            = YES
+
+# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
+# will sort the (detailed) documentation of file and class members
+# alphabetically by member name. If set to NO the members will appear in
+# declaration order.
+
+SORT_MEMBER_DOCS       = NO
+
+# 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.
+
+SORT_BRIEF_DOCS        = NO
+
+# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
+
+SORT_MEMBERS_CTORS_1ST = NO
+
+# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
+# hierarchy of group names into alphabetical order. If set to NO (the default)
+# the group names will appear in their defined order.
+
+SORT_GROUP_NAMES       = NO
+
+# 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.
+
+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
+# commands in the documentation.
+
+GENERATE_TODOLIST      = YES
+
+# The GENERATE_TESTLIST tag can be used to enable (YES) or
+# disable (NO) the test list. This list is created by putting \test
+# commands in the documentation.
+
+GENERATE_TESTLIST      = YES
+
+# The GENERATE_BUGLIST tag can be used to enable (YES) or
+# disable (NO) the bug list. This list is created by putting \bug
+# commands in the documentation.
+
+GENERATE_BUGLIST       = YES
+
+# 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.
+
+GENERATE_DEPRECATEDLIST= YES
+
+# The ENABLED_SECTIONS tag can be used to enable conditional
+# documentation sections, marked by \if sectionname ... \endif.
+
+ENABLED_SECTIONS       =
+
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
+# 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
+# documentation can be controlled using \showinitializer or \hideinitializer
+# command in the documentation regardless of this setting.
+
+MAX_INITIALIZER_LINES  = 30
+
+# 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. The default is NO.
+
+SHOW_DIRECTORIES       = NO
+
+# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
+# This will remove the Files entry from the Quick Index and from the
+# Folder Tree View (if specified). The default is YES.
+
+SHOW_FILES             = YES
+
+# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
+# Namespaces page.
+# This will remove the Namespaces entry from the Quick Index
+# and from the Folder Tree View (if specified). The default is YES.
+
+SHOW_NAMESPACES        = 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 program writes to standard output
+# is used as the file version. See the manual for examples.
+
+FILE_VERSION_FILTER    =
+
+# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
+# doxygen. The layout file controls the global structure of the generated output files
+# in an output format independent way. The create the layout file that represents
+# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
+# file name after the option, if omitted DoxygenLayout.xml will be used as the name
+# of the layout file.
+
+LAYOUT_FILE            =
+
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+
+# The QUIET tag can be used to turn on/off the messages that are generated
+# by doxygen. Possible values are YES and NO. If left blank NO is used.
+
+QUIET                  = YES
+
+# The WARNINGS tag can be used to turn on/off the warning messages that are
+# generated by doxygen. Possible values are YES and NO. If left blank
+# NO is used.
+
+WARNINGS               = YES
+
+# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
+# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
+# automatically be disabled.
+
+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. 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"
+
+# The WARN_LOGFILE tag can be used to specify a file to which warning
+# and error messages should be written. If left blank the output is written
+# to stderr.
+
+WARN_LOGFILE           =
+
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+
+# The INPUT tag can be used to specify the files and/or directories that contain
+# documented source files. You may enter file names like "myfile.cpp" or
+# directories like "/usr/src/myproject". Separate the files or directories
+# with spaces.
+
+INPUT                  = usual doc
+
+# This tag can be used to specify the character encoding of the source files
+# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
+# also the default input encoding. Doxygen uses libiconv (or the iconv built
+# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
+# the list of possible encodings.
+
+INPUT_ENCODING         = UTF-8
+
+# 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 *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
+
+FILE_PATTERNS          = *.h *.dox
+
+# The RECURSIVE tag can be used to turn specify whether or not subdirectories
+# should be searched for input files as well. Possible values are YES and NO.
+# If left blank NO is used.
+
+RECURSIVE              = YES
+
+# The EXCLUDE tag can be used to specify files and/or directories that should
+# 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                =
+
+# 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
+
+# If the value of the INPUT tag contains directories, you can use the
+# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
+# certain files from those directories. Note that the wildcards are matched
+# against the file with absolute path, so to exclude all test directories
+# for example use the pattern */test/*
+
+EXCLUDE_PATTERNS       =
+
+# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
+# (namespaces, classes, functions, etc.) that should be excluded from the
+# output. The symbol name can be a fully qualified name, a word, or if the
+# wildcard * is used, a substring. Examples: ANamespace, AClass,
+# AClass::ANamespace, ANamespace::*Test
+
+EXCLUDE_SYMBOLS        =
+
+# The EXAMPLE_PATH tag can be used to specify one or more files or
+# directories that contain example code fragments that are included (see
+# the \include command).
+
+EXAMPLE_PATH           =
+
+# If the value of the EXAMPLE_PATH tag contains directories, you can use the
+# EXAMPLE_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 all files are included.
+
+EXAMPLE_PATTERNS       =
+
+# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
+# searched for input files to be used with the \include or \dontinclude
+# commands irrespective of the value of the RECURSIVE tag.
+# Possible values are YES and NO. If left blank NO is used.
+
+EXAMPLE_RECURSIVE      = NO
+
+# The IMAGE_PATH tag can be used to specify one or more files or
+# directories that contain image that are included in the documentation (see
+# the \image command).
+
+IMAGE_PATH             =
+
+# The INPUT_FILTER tag can be used to specify a program that doxygen should
+# invoke to filter for each input file. Doxygen will invoke the filter program
+# 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.
+# 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 (i.e. when SOURCE_BROWSER is set to YES).
+
+FILTER_SOURCE_FILES    = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to source browsing
+#---------------------------------------------------------------------------
+
+# 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.
+# Note: To get rid of all source code in the generated output, make sure also
+# VERBATIM_HEADERS is set to NO.
+
+SOURCE_BROWSER         = NO
+
+# Setting the INLINE_SOURCES tag to YES will include the body
+# of functions and classes directly in the documentation.
+
+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
+# then for each documented function all documented
+# functions referencing it will be listed.
+
+REFERENCED_BY_RELATION = YES
+
+# If the REFERENCES_RELATION tag is set to YES
+# then for each documented function all documented entities
+# called/used by that function will be listed.
+
+REFERENCES_RELATION    = YES
+
+# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
+# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
+# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
+# link to the source code.
+# Otherwise they will link to the documentation.
+
+REFERENCES_LINK_SOURCE = YES
+
+# If the USE_HTAGS tag is set to YES then the references to source code
+# will point to the HTML generated by the htags(1) tool instead of doxygen
+# built-in source browser. The htags tool is part of GNU's global source
+# tagging system (see http://www.gnu.org/software/global/global.html). You
+# will need version 4.8.6 or higher.
+
+USE_HTAGS              = 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       = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+
+# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
+# of all compounds will be generated. Enable this if the project
+# contains a lot of classes, structs, unions or interfaces.
+
+ALPHABETICAL_INDEX     = NO
+
+# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
+# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
+# in which this list will be split (can be a number in the range [1..20])
+
+COLS_IN_ALPHA_INDEX    = 5
+
+# In case all classes in a project start with a common prefix, all
+# classes will be put under the same header in the alphabetical index.
+# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
+# should be ignored while generating the index headers.
+
+IGNORE_PREFIX          =
+
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
+# generate HTML output.
+
+GENERATE_HTML          = YES
+
+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `html' will be used as the default path.
+
+HTML_OUTPUT            = html
+
+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
+# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
+# doxygen will generate files with .html extension.
+
+HTML_FILE_EXTENSION    = .html
+
+# The HTML_HEADER tag can be used to specify a personal HTML header for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard header.
+
+HTML_HEADER            =
+
+# The HTML_FOOTER tag can be used to specify a personal HTML footer for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard footer.
+
+HTML_FOOTER            =
+
+# 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. 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        =
+
+# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
+# page will contain the date and time when the page was generated. Setting
+# this to NO can help when comparing the output of multiple runs.
+
+HTML_TIMESTAMP         = YES
+
+# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
+# files or namespaces will be aligned in HTML using tables. If set to
+# NO a bullet list will be used.
+
+HTML_ALIGN_MEMBERS     = YES
+
+# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
+# documentation will contain sections that can be hidden and shown after the
+# page has loaded. For this to work a browser that supports
+# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
+# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
+
+HTML_DYNAMIC_SECTIONS  = NO
+
+# If the GENERATE_DOCSET tag is set to YES, additional index files
+# will be generated that can be used as input for Apple's Xcode 3
+# integrated development environment, introduced with OSX 10.5 (Leopard).
+# To create a documentation set, doxygen will generate a Makefile in the
+# HTML output directory. Running make will produce the docset in that
+# directory and running "make install" will install the docset in
+# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
+# it at startup.
+# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
+
+GENERATE_DOCSET        = NO
+
+# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
+# feed. A documentation feed provides an umbrella under which multiple
+# documentation sets from a single provider (such as a company or product suite)
+# can be grouped.
+
+DOCSET_FEEDNAME        = "Doxygen generated docs"
+
+# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
+# should uniquely identify the documentation set bundle. This should be a
+# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
+# will append .docset to the name.
+
+DOCSET_BUNDLE_ID       = org.doxygen.Project
+
+# If the GENERATE_HTMLHELP tag is set to YES, additional index files
+# will be generated that can be used as input for tools like the
+# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
+# of the generated HTML documentation.
+
+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).
+
+GENERATE_CHI           = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
+# is used to encode HtmlHelp index (hhk), content (hhc) and project file
+# content.
+
+CHM_INDEX_ENCODING     =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
+# controls whether a binary table of contents is generated (YES) or a
+# normal table of contents (NO) in the .chm file.
+
+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.
+
+TOC_EXPAND             = NO
+
+# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
+# are set, an additional index file will be generated that can be used as input for
+# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
+# HTML documentation.
+
+GENERATE_QHP           = NO
+
+# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
+# be used to specify the file name of the resulting .qch file.
+# The path specified is relative to the HTML output folder.
+
+QCH_FILE               =
+
+# The QHP_NAMESPACE tag specifies the namespace to use when generating
+# Qt Help Project output. For more information please see
+# http://doc.trolltech.com/qthelpproject.html#namespace
+
+QHP_NAMESPACE          = org.doxygen.Project
+
+# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
+# Qt Help Project output. For more information please see
+# http://doc.trolltech.com/qthelpproject.html#virtual-folders
+
+QHP_VIRTUAL_FOLDER     = doc
+
+# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
+# For more information please see
+# http://doc.trolltech.com/qthelpproject.html#custom-filters
+
+QHP_CUST_FILTER_NAME   =
+
+# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
+# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
+
+QHP_CUST_FILTER_ATTRS  =
+
+# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
+# filter section matches.
+# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
+
+QHP_SECT_FILTER_ATTRS  =
+
+# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
+# be used to specify the location of Qt's qhelpgenerator.
+# If non-empty doxygen will try to run qhelpgenerator on the generated
+# .qhp file.
+
+QHG_LOCATION           =
+
+# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
+#  will be generated, which together with the HTML files, form an Eclipse help
+#  plugin. To install this plugin and make it available under the help contents
+# menu in Eclipse, the contents of the directory containing the HTML and XML
+# files needs to be copied into the plugins directory of eclipse. The name of
+# the directory within the plugins directory should be the same as
+# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before the help appears.
+
+GENERATE_ECLIPSEHELP   = NO
+
+# A unique identifier for the eclipse help plugin. When installing the plugin
+# the directory name containing the HTML and XML files should also have
+# this name.
+
+ECLIPSE_DOC_ID         = org.doxygen.Project
+
+# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
+# top of each HTML page. The value NO (the default) enables the index and
+# the value YES disables it.
+
+DISABLE_INDEX          = NO
+
+# This tag can be used to set the number of enum values (range [1..20])
+# that doxygen will group on one line in the generated HTML documentation.
+
+ENUM_VALUES_PER_LINE   = 4
+
+# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
+# structure should be generated to display hierarchical information.
+# If the tag value 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, DHTML, CSS and frames is required (i.e. any modern browser).
+# Windows users are probably better off using the HTML help feature.
+
+GENERATE_TREEVIEW      = NO
+
+# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
+# and Class Hierarchy pages using a tree view instead of an ordered list.
+
+USE_INLINE_TREES       = NO
+
+# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
+# used to set the initial width (in pixels) of the frame in which the tree
+# is shown.
+
+TREEVIEW_WIDTH         = 250
+
+# Use this tag to change the font size of Latex formulas included
+# as images in the HTML documentation. The default is 10. Note that
+# when you change the font size after a successful doxygen run you need
+# to manually remove any form_*.png images from the HTML output directory
+# to force them to be regenerated.
+
+FORMULA_FONTSIZE       = 10
+
+# When the SEARCHENGINE tag is enabled doxygen will generate a search box for the HTML output. The underlying search engine uses javascript
+# and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) there is already a search function so this one should
+# typically be disabled. For large projects the javascript based search engine
+# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
+
+SEARCHENGINE           = NO
+
+# When the SERVER_BASED_SEARCH tag is enabled the search engine will be implemented using a PHP enabled web server instead of at the web client using Javascript. Doxygen will generate the search PHP script and index
+# file to put on the web server. The advantage of the server based approach is that it scales better to large projects and allows full text search. The disadvances is that it is more difficult to setup
+# and does not have live searching capabilities.
+
+SERVER_BASED_SEARCH    = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
+# generate Latex output.
+
+GENERATE_LATEX         = NO
+
+# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `latex' will be used as the default path.
+
+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.
+# Note that when enabling USE_PDFLATEX this option is only used for
+# generating bitmaps for formulas in the HTML output, but not in the
+# Makefile that is written to the output directory.
+
+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.
+
+COMPACT_LATEX          = NO
+
+# The PAPER_TYPE tag can be used to set the paper type that is used
+# by the printer. Possible values are: a4, a4wide, letter, legal and
+# executive. If left blank a4wide will be used.
+
+PAPER_TYPE             = a4wide
+
+# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
+# packages that should be included in the LaTeX output.
+
+EXTRA_PACKAGES         =
+
+# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
+# the generated latex document. The header should contain everything until
+# the first chapter. If it is left blank doxygen will generate a
+# standard header. Notice: only use this tag if you know what you are doing!
+
+LATEX_HEADER           =
+
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
+# is prepared for conversion to pdf (using ps2pdf). The pdf file will
+# contain links (just like the HTML output) instead of page references
+# This makes the output suitable for online browsing using a pdf viewer.
+
+PDF_HYPERLINKS         = NO
+
+# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
+# plain latex in the generated Makefile. Set this option to YES to get a
+# higher quality PDF documentation.
+
+USE_PDFLATEX           = NO
+
+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
+# command to the generated LaTeX files. This will instruct LaTeX to keep
+# running if errors occur, instead of asking the user for help.
+# This option is also used when generating formulas in HTML.
+
+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
+
+# If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER.
+
+LATEX_SOURCE_CODE      = 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 optimized for Word 97 and may not look very pretty with
+# other RTF readers or editors.
+
+GENERATE_RTF           = NO
+
+# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `rtf' will be used as the default path.
+
+RTF_OUTPUT             = rtf
+
+# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
+# RTF documents. This may be useful for small projects and may help to
+# save some trees in general.
+
+COMPACT_RTF            = NO
+
+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
+# will contain hyperlink fields. The RTF file will
+# contain links (just like the HTML output) instead of page references.
+# This makes the output suitable for online browsing using WORD or other
+# programs which support those fields.
+# Note: wordpad (write) and others do not support links.
+
+RTF_HYPERLINKS         = NO
+
+# Load stylesheet definitions from file. Syntax is similar to doxygen's
+# 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    =
+
+# Set optional variables used in the generation of an rtf document.
+# Syntax is similar to doxygen's config file.
+
+RTF_EXTENSIONS_FILE    =
+
+#---------------------------------------------------------------------------
+# configuration options related to the man page output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
+# generate man pages
+
+GENERATE_MAN           = NO
+
+# The MAN_OUTPUT tag is used to specify where the man 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 `man' will be used as the default path.
+
+MAN_OUTPUT             = man
+
+# The MAN_EXTENSION tag determines the extension that is added to
+# the generated man pages (default is the subroutine's section .3)
+
+MAN_EXTENSION          = .3
+
+# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
+# then it will generate one additional man file for each entity
+# documented in the real man page(s). These additional files
+# only source the real man page, but without them the man command
+# would be unable to find the correct page. The default is NO.
+
+MAN_LINKS              = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the XML output
+#---------------------------------------------------------------------------
+
+# 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.
+
+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
+#---------------------------------------------------------------------------
+
+# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
+# generate an AutoGen Definitions (see autogen.sf.net) file
+# that captures the structure of the code including all
+# documentation. Note that this feature is still experimental
+# and incomplete at the moment.
+
+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
+#---------------------------------------------------------------------------
+
+# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
+# evaluate all C-preprocessor directives found in the sources and include
+# files.
+
+ENABLE_PREPROCESSING   = YES
+
+# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
+# names in the source code. If set to NO (the default) only conditional
+# compilation will be performed. Macro expansion can be done in a controlled
+# way by setting EXPAND_ONLY_PREDEF to YES.
+
+MACRO_EXPANSION        = NO
+
+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
+# then the macro expansion is limited to the macros specified with the
+# PREDEFINED and EXPAND_AS_DEFINED tags.
+
+EXPAND_ONLY_PREDEF     = NO
+
+# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
+# in the INCLUDE_PATH (see below) will be search if a #include is found.
+
+SEARCH_INCLUDES        = YES
+
+# The INCLUDE_PATH tag can be used to specify one or more directories that
+# contain include files that are not input files but should be processed by
+# the preprocessor.
+
+INCLUDE_PATH           =
+
+# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
+# patterns (like *.h and *.hpp) to filter out the header-files in the
+# directories. If left blank, the patterns specified with FILE_PATTERNS will
+# be used.
+
+INCLUDE_FILE_PATTERNS  =
+
+# The PREDEFINED tag can be used to specify one or more macro names that
+# 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. 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_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.
+
+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, 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::additions related to external references
+#---------------------------------------------------------------------------
+
+# 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               =
+
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create
+# a tag file that is based on the input files it reads.
+
+GENERATE_TAGFILE       =
+
+# If the ALLEXTERNALS tag is set to YES all external classes will be listed
+# in the class index. If set to NO only the inherited external classes
+# will be listed.
+
+ALLEXTERNALS           = NO
+
+# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
+# in the modules index. If set to NO, only the current project's groups will
+# be listed.
+
+EXTERNAL_GROUPS        = YES
+
+# The PERL_PATH should be the absolute path and name of the perl script
+# interpreter (i.e. the result of `which perl').
+
+PERL_PATH              = /usr/bin/perl
+
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+
+# 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 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         = NO
+
+# You can define message sequence charts within doxygen comments using the \msc
+# command. Doxygen will then run the mscgen tool (see
+# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
+# documentation. The MSCGEN_PATH tag allows you to specify the directory where
+# the mscgen tool resides. If left empty the tool is assumed to be found in the
+# default search path.
+
+MSCGEN_PATH            =
+
+# 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
+# have no effect if this option is set to NO (the default)
+
+HAVE_DOT               = NO
+
+# By default doxygen will write a font called FreeSans.ttf to the output
+# directory and reference it in all dot files that doxygen generates. This
+# font does not include all possible unicode characters however, so when you need
+# these (or just want a differently looking font) you can specify the font name
+# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
+# which can be done by putting it in a standard location or by setting the
+# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
+# containing the font.
+
+DOT_FONTNAME           = FreeSans
+
+# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
+# The default size is 10pt.
+
+DOT_FONTSIZE           = 10
+
+# By default doxygen will tell dot to use the output directory to look for the
+# FreeSans.ttf font (which doxygen will put there itself). If you specify a
+# different font using DOT_FONTNAME you can set the path where dot
+# can find it using this tag.
+
+DOT_FONTPATH           =
+
+# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for each documented class showing the direct and
+# indirect inheritance relations. Setting this tag to YES will force the
+# the CLASS_DIAGRAMS tag to NO.
+
+CLASS_GRAPH            = YES
+
+# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for each documented class showing the direct and
+# indirect implementation dependencies (inheritance, containment, and
+# class references variables) of the class with other documented classes.
+
+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     = NO
+
+# 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
+# other documented files.
+
+INCLUDE_GRAPH          = NO
+
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
+# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
+# documented header file showing the documented files that directly or
+# indirectly include this file.
+
+INCLUDED_BY_GRAPH      = YES
+
+# If the CALL_GRAPH and HAVE_DOT options 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 CALLER_GRAPH and HAVE_DOT tags are set to YES then
+# doxygen will generate a caller 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 caller
+# graphs for selected functions only using the \callergraph command.
+
+CALLER_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    = NO
+
+# 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        = NO
+
+# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
+# generated by dot. Possible values are png, jpg, or gif
+# If left blank png will be used.
+
+DOT_IMAGE_FORMAT       = png
+
+# 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 in the path.
+
+DOT_PATH               =
+
+# The DOTFILE_DIRS tag can be used to specify one or more directories that
+# contain dot files that are included in the documentation (see the
+# \dotfile command).
+
+DOTFILE_DIRS           =
+
+# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
+# nodes that will be shown in the graph. If the number of nodes in a graph
+# becomes larger than this value, doxygen will truncate the graph, which is
+# visualized by representing a node as a red box. Note that doxygen if the
+# number of direct children of the root node in a graph is already larger than
+# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
+# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
+
+DOT_GRAPH_MAX_NODES    = 50
+
+# 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 the size of a graph can be further restricted by
+# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
+
+MAX_DOT_GRAPH_DEPTH    = 0
+
+# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
+# background. This is disabled by default, because dot on Windows does not
+# seem to support this out of the box. 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.
+
+GENERATE_LEGEND        = YES
+
+# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
+# remove the intermediate dot files that are used to generate
+# the various graphs.
+
+DOT_CLEANUP            = YES
diff --git a/doc/mainpage.dox b/doc/mainpage.dox
new file mode 100644 (file)
index 0000000..69f7384
--- /dev/null
@@ -0,0 +1,55 @@
+/**
+ * @mainpage
+ *
+ * @section libusual    Introduction.
+ *
+ * libusual is utility library.
+ *
+ *
+ * @section modules  Module list.
+ *
+ * <table>
+ * <tr><th colspan=2>  Compat includes  </th></tr>
+ * <tr><td>  <usual/base.h>          </td><td>  Base C environment  </td></tr>
+ * <tr><td>  <usual/pthread.h>       </td><td>  Pthreads compat   </td></tr>
+ * <tr><td>  <usual/signal.h>        </td><td>  Signal compat   </td></tr>
+ * <tr><td>  <usual/socket.h>        </td><td>  Socket compat and helper functions   </td></tr>
+ * <tr><td>  <usual/string.h>        </td><td>  String compat and helper functions   </td></tr>
+ * <tr><td>  <usual/time.h>          </td><td>  Time compat and helper functions   </td></tr>
+ * <tr><th colspan=2>  Data Structures  </th></tr>
+ * <tr><td>  <usual/aatree.h>        </td><td>  Binary Tree   </td></tr>
+ * <tr><td>  <usual/cbtree.h>        </td><td>  Crit-Bit Tree   </td></tr>
+ * <tr><td>  <usual/hashtab-impl.h>  </td><td>  Hash table   </td></tr>
+ * <tr><td>  <usual/heap-impl.h>     </td><td>  Min/Max heap   </td></tr>
+ * <tr><td>  <usual/list.h>          </td><td>  Double-linked list   </td></tr>
+ * <tr><td>  <usual/mbuf.h>          </td><td>  Memory buffer   </td></tr>
+ * <tr><td>  <usual/mdict.h          </td><td>  Minimal dict   </td></tr>
+ * <tr><td>  <usual/shlist.h>        </td><td>  Double-linked list for shared mem   </td></tr>
+ * <tr><td>  <usual/statlist.h>      </td><td>  List with stats   </td></tr>
+ * <tr><td>  <usual/strpool.h>       </td><td>  Refcounted strings   </td></tr>
+ * <tr><th colspan=2>  Data Processing  </th></tr>
+ * <tr><td>  <usual/cfparser.h>      </td><td>  Config parser   </td></tr>
+ * <tr><td>  <usual/crc32.h>         </td><td>  CRC32   </td></tr>
+ * <tr><td>  <usual/endian.h>        </td><td>  Endianess conversion   </td></tr>
+ * <tr><td>  <usual/lookup3.h>       </td><td>  Jenkins' lookup3 hash   </td></tr>
+ * <tr><td>  <usual/misc.h>          </td><td>  Misc arithmetic   </td></tr>
+ * <tr><td>  <usual/md5.h>           </td><td>  MD5 hash   </td></tr>
+ * <tr><td>  <usual/sha1.h>          </td><td>  SHA1 hash   </td></tr>
+ * <tr><td>  <usual/regex.h>         </td><td>  POSIX regex compat   </td></tr>
+ * <tr><td>  <usual/pgutil.h>        </td><td>  PostgreSQL data formats   </td></tr>
+ * <tr><td>  <usual/utf8.h>          </td><td>  Low-level UTF8 handling   </td></tr>
+ * <tr><th colspan=2>  Memory Allocation  </th></tr>
+ * <tr><td>  <usual/cxalloc.h>       </td><td>  Context Allocator framework   </td></tr>
+ * <tr><td>  <usual/cxextra.h>       </td><td>  Extra allocators   </td></tr>
+ * <tr><td>  <usual/mempool.h>       </td><td>  Simple append-only memory pool   </td></tr>
+ * <tr><td>  <usual/slab.h>          </td><td>  Slab allocator for same-size objects   </td></tr>
+ * <tr><th colspan=2>  OS support  </th></tr>
+ * <tr><td>  <usual/event.h>         </td><td>  libevent compat   </td></tr>
+ * <tr><td>  <usual/daemon.h>        </td><td>  Process daemonization   </td></tr>
+ * <tr><td>  <usual/err.h>           </td><td>  Error handling for command-line tools  </td></tr>
+ * <tr><td>  <usual/fileutil.h>      </td><td>  Various file I/O tools   </td></tr>
+ * <tr><td>  <usual/logging.h>       </td><td>  Logging framework for daemons   </td></tr>
+ * <tr><td>  <usual/pgsocket.h>      </td><td>  Async Postgres connection framework   </td></tr>
+ * <tr><td>  <usual/safeio.h>        </td><td>  Safety wrappers around OS I/O   </td></tr>
+ * </table>
+ */
diff --git a/doc/setup.dox b/doc/setup.dox
new file mode 100644 (file)
index 0000000..9e80060
--- /dev/null
@@ -0,0 +1,5 @@
+/**
+ * @page setup How to setup libusual
+ *
+ * Foo
+ */
index aff1a9dc664758d999df609cc6928a28d97c87b4..23f26bf28585ac704a1dd67e7233db124d0d9f40 100644 (file)
@@ -1,6 +1,4 @@
 /*
- * AA-Tree - Binary tree with embeddable nodes.
- * 
  * Copyright (c) 2007-2009  Marko Kreen, Skype Technologies OÜ
  * 
  * Permission to use, copy, modify, and/or distribute this software for any
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
 
+/** @file
+ *
+ * AA-Tree - Binary tree with embeddable nodes.
+ *
+ * AA-Tree (Arne Andersson tree) is a simplified Red-Black tree.
+ */
+
 #ifndef _USUAL_AATREE_H_
 #define _USUAL_AATREE_H_
 
 struct AATree;
 struct AANode;
 
+/** Callback for node comparision against value */
 typedef int (*aatree_cmp_f)(long, struct AANode *node);
+
+/** Callback for walking the tree */
 typedef void (*aatree_walker_f)(struct AANode *n, void *arg);
 
-/*
+/**
  * Tree header, for storing helper functions.
  */
 struct AATree {
@@ -37,32 +45,49 @@ struct AATree {
        aatree_walker_f release_cb;
 };
 
-/*
- * Tree node.
+/**
+ * Tree node.  Embeddable, parent structure should be taken
+ * with container_of().
+ *
+ * Techinally, the full level is not needed and 2-lowest
+ * bits of either ->left or ->right would be enough
+ * to keep track of structure.  Currently this is not
+ * done to keep code simple.
  */
 struct AANode {
-       struct AANode *left;    /* smaller values */
-       struct AANode *right;   /* larger values */
-       int level;              /* number of black nodes to leaf */
+       struct AANode *left;    /**<  smaller values */
+       struct AANode *right;   /**<  larger values */
+       int level;              /**<  number of black nodes to leaf */
 };
 
-/*
- * walk order
+/**
+ * Walk order types.
  */
 enum AATreeWalkType {
-       AA_WALK_IN_ORDER = 0, /* left->self->right */
-       AA_WALK_PRE_ORDER = 1, /* self->left->right */
-       AA_WALK_POST_ORDER = 2, /* left->right->self */
+       AA_WALK_IN_ORDER = 0,   /* left->self->right */
+       AA_WALK_PRE_ORDER = 1,  /* self->left->right */
+       AA_WALK_POST_ORDER = 2, /* left->right->self */
 };
 
+/** Initialize structure */
 void aatree_init(struct AATree *tree, aatree_cmp_f cmpfn, aatree_walker_f release_cb);
+
+/** Search for node */
 struct AANode *aatree_search(struct AATree *tree, long value);
+
+/** Insert new node */
 void aatree_insert(struct AATree *tree, long value, struct AANode *node);
+
+/** Remote node */
 void aatree_remove(struct AATree *tree, long value);
+
+/** Walk over all nodes */
 void aatree_walk(struct AATree *tree, enum AATreeWalkType wtype, aatree_walker_f walker, void *arg);
+
+/** Free */
 void aatree_destroy(struct AATree *tree);
 
-/* aatree does not use NULL pointers */
+/** Check if terminal node. */
 static inline int aatree_is_nil_node(const struct AANode *node)
 {
        return (node->left == node);
index 52c39e17fbc60adea7d936030e0368d31e3523a8..9238c6a3d845b92dc3b443769064a60dd76896b7 100644 (file)
@@ -1,6 +1,8 @@
-/*
+/** @file
  * Basic C environment.
- *
+ */
+
+/*
  * Copyright (c) 2007-2009 Marko Kreen
  *
  * Permission to use, copy, modify, and/or distribute this software for any
 #define DLLIMPORT
 #endif
 
-/* give offset of a field inside struct */
+/** give offset of a field inside struct */
 #ifndef offsetof
 #define offsetof(type, field) ((unsigned long)&(((type *)0)->field))
 #endif
 
-/* given pointer to field inside struct, return pointer to struct */
+/** given pointer to field inside struct, return pointer to struct */
 #ifndef container_of
 #define container_of(ptr, type, field) ((type *)((char *)(ptr) - offsetof(type, field)))
 #endif
 
-/* power-of-2 alignment */
+/** power-of-2 alignment */
 #ifndef CUSTOM_ALIGN
 #define CUSTOM_ALIGN(x, a) (((unsigned long)(x) + (a) - 1) & ~((a) - 1))
 #endif
 
-/* preferred alignment */
+/** preferred alignment */
 #ifndef ALIGN
 #define ALIGN(x)  CUSTOM_ALIGN(x, sizeof(long))
 #endif
 
-/* number of elements in array */
+/** number of elements in array */
 #define ARRAY_NELEM(a) (sizeof(a) / sizeof((a)[0]))
 
 /* how to specify array with unknown length */
 #define FLEX_ARRAY 1
 #endif
 
-/* tag for packed structure */
+/**
+ * @name Compiler attributes.
+ */
+
+/** Disable padding for structure */
 #define _PACKED                        __attribute__((packed))
 
 /*
 #ifndef _MUSTCHECK
 #if defined(__GNUC__) && (__GNUC__ >= 4)
 
-/* additional error checking */
+/** Show warning if function result is not used */
 #define _MUSTCHECK              __attribute__((warn_unused_result))
+/** Show warning if used */
 #define _DEPRECATED             __attribute__((deprecated))
+/** Check printf-style format and arg sanity */
 #define _PRINTF(fmtpos, argpos) __attribute__((format(printf, fmtpos, argpos)))
+/** Function returns new pointer */
 #define _MALLOC                 __attribute__((malloc))
+/** Disable 'unused' warning for function/argument. */
 #define _UNUSED                 __attribute__((unused))
+/** Do not inline function. */
 #define _NOINLINE               __attribute__((noinline))
 
 /* compiler hints - those do not seem to work well */
 #endif
 #endif
 
-/* assert() that uses our logging */
+/* @} */
+
+/** assert() that uses <usual/logging> module  */
 #ifndef Assert
 #ifdef CASSERT
 void log_fatal(const char *file, int line, const char *func, bool show_perror, void *ctx, const char *s, ...) _PRINTF(6, 7);
@@ -142,9 +155,10 @@ static inline void _const_free(const void *p)
 {
        free((void *)p);
 }
+/** Compat: make free() accept const pointer */
 #define free(x) _const_free(x)
 
-/* Zeroing malloc */
+/** Zeroing malloc */
 _MUSTCHECK
 static inline void *zmalloc(size_t len)
 {
@@ -153,12 +167,13 @@ static inline void *zmalloc(size_t len)
 
 #ifndef HAVE_POSIX_MEMALIGN
 #define posix_memalign(a,b,c) usual_memalign(a,b,c)
+/** Compat: posix_memalign() */
 int posix_memalign(void **ptr_p, size_t align, size_t len);
 #endif
 
-/* cpp expr -> string */
-#define _STR_(identifier) #identifier
+/** cpp expr -> string */
 #define STR(x) _STR_(x)
+#define _STR_(x) #x
 
 #endif
 
index 6ea4abc4b261d212084b5dd1ae813e594a9954e5..40b3e4218d320c220810288b3842907549bd7d9c 100644 (file)
@@ -1,22 +1,19 @@
-
 /*
- * Context Allocator framework.
+ * libusual - Utility library for C
  *
- * The idea is that each data structure is given a context to allocate from,
- * and it can create subcontext for that.  It is slightly more work to
- * use than palloc (PostgreSQL) or talloc (Samba), but it avoids the need
- * to have big fully-featured framework, that does everything at once.
+ * Copyright (c) 2007-2009  Marko Kreen, Skype Technologies OÜ
  *
- * Instead you have small task-specific allocators, and you can always fall
- * back to raw malloc if you want to valgrind the code.
+ * Permission to use, copy, modify, and/or distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
  *
- * Potential variants:
- * - fully-featured pooled
- * - randomly failing
- * - logging
- * - locking
- * - guard signatures
- * - palloc / talloc like API
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
 
 #include <usual/cxalloc.h>
index 72325bfbe7ac5d33c4f889d122d4610d0c334082..02268923d6e2f5cb81e3fad30561b352aaee14a0 100644 (file)
+/*
+ * Copyright (c) 2007-2009  Marko Kreen, Skype Technologies OÜ
+ *
+ * Permission to use, copy, modify, and/or distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ */
+
+/**
+ * @file
+ *
+ * Context-based Memory Allocator.
+ *
+ * The idea is that each data structure is given a context to allocate from,
+ * and it can create subcontext for that which can be specific allocation
+ * pattern that matches the data structure.
+ *
+ * It is slightly more work to use than palloc (PostgreSQL) or talloc (Samba),
+ * but it avoids the need to have big fully-featured framework that does
+ * everything at once.
+ *
+ * Instead you have small task-specific allocators, and you can always fall
+ * back to raw malloc if you want to valgrind the code.
+ *
+ * Potential variants:
+ * - fully-featured pooled
+ * - randomly failing
+ * - logging
+ * - locking
+ * - guard signatures
+ * - palloc / talloc like API
+ */
 
 #ifndef _USUAL_CXALLOC_H_
 #define _USUAL_CXALLOC_H_
 
 #include <usual/base.h>
 
-/*
+/**
  * Ops for allocator that takes context.
+ *
+ * NB! - they are not equivalent to cx_* API.  The cx_*
+ * functions do additional sanitizing.
  */
 struct CxOps {
+       /**
+        * Allocate memory.
+        * len will not be 0.
+        */
        void *(*c_alloc)(void *ctx, size_t len);
+       /**
+        * Resize existing allocation.
+        * Both p and len will not be 0
+        */
        void *(*c_realloc)(void *ctx, void *p, size_t len);
+       /**
+        * Free existing allocation.
+        * p will not be 0
+        */
        void (*c_free)(void *ctx, const void *p);
+       /**
+        * Release all memory in context.
+        * This is not supported by all allocators.
+        */
        void (*c_destroy)(void *ctx);
 };
 
-/*
- * Specific memory allocation context.
+/**
+ * Memory allocation context.
  */
 struct CxMem {
        const struct CxOps *ops;
        void *ctx;
 };
 
+/** Shortcut to const CxMem */
 typedef const struct CxMem CxMem;
 
 /*
  * Basic operations on allocation context.
  */
 
+/**
+ * Allocate memory from context.
+ *
+ * Returns NULL if no memory or len == 0.
+ */
 void *cx_alloc(CxMem *cx, size_t len) _MALLOC;
+
+/**
+ * Change existing allocation.
+ *
+ * If ptr is NULL it creates new allocation.
+ * If len is 0 it frees the memory.
+ */
 void *cx_realloc(CxMem *cx, void *ptr, size_t len);
+
+/**
+ * Free existing allocation.
+ *
+ * Does nothing if ptr is NULL.
+ */
 void cx_free(CxMem *cx, const void *ptr);
+
+/**
+ * Release all memory allocated in context.
+ *
+ * Should be called only on contexts that support it.
+ */
 void cx_destroy(CxMem *cx);
+
+/** Allocate and zero-fill memory */
 void *cx_alloc0(CxMem *cx, size_t len) _MALLOC;
+
+/** Allocate and copy */
 void *cx_memdup(CxMem *cx, const void *src, size_t len) _MALLOC;
+
+/** Allocate and copy string */
 void *cx_strdup(CxMem *cx, const char *str) _MALLOC;
 
 
-/* Allocator that uses libc malloc/realloc/free */
+/** Allocator that uses libc malloc/realloc/free */
 extern CxMem cx_libc_allocator;
 
-/* Default allocator */
+/** Default allocator */
 #ifndef USUAL_ALLOC
 #define USUAL_ALLOC (&cx_libc_allocator)
 #endif
index 9a0ef3ee5b2e881179f350098d21f7d9a74e50d6..4d7c85431870f313053e90d74e2ac70bdfa31a2f 100644 (file)
@@ -1,6 +1,7 @@
-/*
+/** @file
  * Daemonization & pidfile handling.
- *
+ */
+/*
  * Copyright (c) 2007-2009 Marko Kreen, Skype Technologies OÜ
  *
  * Permission to use, copy, modify, and/or distribute this software for any
@@ -23,6 +24,9 @@
 
 bool signal_pidfile(const char *pidfile, int sig);
 
+/**
+ * Daemonize process and write pidfile.
+ */
 void daemonize(const char *pidfile, bool go_background);
 
 #endif
index 15d5412b7897941509da0eadbd269872773ff011..c95c210969b8eba45533c3d5cc306673ef2712dc 100644 (file)
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
 
+/**
+ * @file
+ *
+ * Error printing for command-line utilities.
+ */
 #ifndef _USUAL_ERR_H_
 #define _USUAL_ERR_H_
 
 #endif
 
 #ifndef HAVE_ERR
+/** Print formatted message and strerror(errno) to stderr and exit with given error code */
 void err(int e, const char *fmt, ...);
 #endif
 #ifndef HAVE_ERRX
+/** Print formatted message to stderr and exit with given error code */
 void errx(int e, const char *fmt, ...);
 #endif
 #ifndef HAVE_WARN
+/** Print formatted message and strerror(errno) to stderr */
 void warn(const char *fmt, ...);
 #endif
 #ifndef HAVE_WARNX
+/** Print formatted message to stderr */
 void warnx(const char *fmt, ...);
 #endif
 #ifndef HAVE_SETPROGNAME
+/** Set program name to that will printed as prefix to error messages */
 void setprogname(const char *s);
 #endif
 #ifndef HAVE_GETPROGNAME
+/** Return program name set with @ref setprogname */
 const char *getprogname(void);
 #endif
 
+/** Malloc that exits on failure */
 void *xmalloc(size_t len);
+
+/** Realloc that exits on failure */
 void *xrealloc(void *p, size_t len);
+
+/** strdup that exits on failure */
 char *xstrdup(const char *s);
 
 #endif
index 9fc5e400aeed3c4031744fee97dc54c46096805e..a78e53c06e46d0949c2577680ddf86985b4c5bbb 100644 (file)
@@ -1,6 +1,4 @@
 /*
- * Simple customizable hashtable implementation.
- *
  * Copyright (c) 2009  Marko Kreen
  *
  * Permission to use, copy, modify, and/or distribute this software for any
@@ -16,8 +14,9 @@
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
 
-
-/*
+/** @file
+ * Simple customizable hashtable implementation.
+ *
  * - Fixed-size hash table, open-addressed
  * - Extended by linking several together
  * - Resizable by copying.
 #include <string.h>
 
 #ifndef HTAB_KEY_T
+/** Overridable type for key */
 #define HTAB_KEY_T unsigned long
 #endif
 #ifndef HTAB_VAL_T
+/** Overridable type for value */
 #define HTAB_VAL_T void *
 #endif
 
 #define HTAB_WMB
 #endif
 
+/** Typedef for key */
 typedef HTAB_KEY_T htab_key_t;
+/** Typedef for value */
 typedef HTAB_VAL_T htab_val_t;
 
 #ifndef HTAB_ITEM
 #define HTAB_ITEM
+/** HashTab slot */
 struct HashItem {
        htab_key_t key;
        htab_val_t value;
 };
 #endif
 
+/** Signature for comparision function */
 typedef bool (*hash_cmp_fn)(const htab_val_t curval, const void *arg);
 
 #ifndef HTAB_MAX_FILL
+/** Max fill percentage */
 #define HTAB_MAX_FILL 75
 #endif
 
@@ -66,6 +72,7 @@ typedef bool (*hash_cmp_fn)(const htab_val_t curval, const void *arg);
 #define NEXT_POS(h, pos) (((pos) * 5 + 1) & MASK(h))
 #define MAX_USED(h) ((h)->size * HTAB_MAX_FILL / 100)
 
+/** Single HashTab segment */
 struct HashTab {
        struct HashTab *next;
        hash_cmp_fn cmp_fn;
@@ -75,6 +82,7 @@ struct HashTab {
        struct HashItem tab[];
 };
 
+/** Initialize HashTab */
 static struct HashTab *hashtab_create(unsigned size, hash_cmp_fn cmp_fn, CxMem *ca)
 {
        struct HashTab *h;
@@ -88,6 +96,7 @@ static struct HashTab *hashtab_create(unsigned size, hash_cmp_fn cmp_fn, CxMem *
        return h;
 }
 
+/** Free HashTab */
 static void hashtab_destroy(struct HashTab *h)
 {
        struct HashTab *tmp;
@@ -98,6 +107,7 @@ static void hashtab_destroy(struct HashTab *h)
        }
 }
 
+/** Element lookup, optionally inserting new slot */
 static htab_val_t *hashtab_lookup(struct HashTab *h, htab_key_t key, bool do_insert, const void *arg)
 {
        unsigned pos;
@@ -157,6 +167,7 @@ static bool _hashtab_slot_can_move(struct HashTab *h, unsigned dstpos, unsigned
        return true;
 }
 
+/** Delete an element */
 static void hashtab_delete(struct HashTab *h, htab_key_t key, void *arg)
 {
        htab_val_t *vptr;
@@ -192,6 +203,7 @@ loop:
        h->used--;
 }
 
+/** Count elements and fragments */
 static void hashtab_stats(struct HashTab *h, unsigned *nitem_p, unsigned *ntab_p)
 {
        unsigned n = 0, l = 0;
@@ -204,6 +216,7 @@ static void hashtab_stats(struct HashTab *h, unsigned *nitem_p, unsigned *ntab_p
        *ntab_p = l;
 }
 
+/** Copy elements to new hashtab, perhaps with different size */
 static struct HashTab *hashtab_copy(struct HashTab *h_old, unsigned newsize)
 {
        struct HashTab *h_new;
index b3097db1a9c2836ce960544442fef997da617dbb..865f432d0690deab819d7461969bba45eecd7adb 100644 (file)
@@ -16,7 +16,9 @@
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
 
-/*
+/** @file
+ * Binary heap.
+ *
  * Summary - binary heap is sort of binary tree held inside array,
  * with following 2 properties:
  * - heap property: each node is "better" than it's childs.
index b03298d03f5aef33ee6458dd852d2f1747e0c9b9..f9f049245ff5775a29ed1d30410cacb6d09527c8 100644 (file)
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
 
+/**
+ * @file
+ * Circular doubly linked list.
+ */
+
 #ifndef _USUAL_LIST_H_
 #define _USUAL_LIST_H_
 
 #include <usual/base.h>
 
-/* list type */
+/**
+ * Structure for both list nodes and heads.
+ *
+ * It is meant to be embedded in parent structure,
+ * which can be acquired with container_of().
+ */
 struct List {
+       /** Pointer to next node or head. */
        struct List *next;
+       /** Pointer to previous node or head. */
        struct List *prev;
 };
 
+/** Define and initialize emtpy list head */
 #define LIST(var) struct List var = { &var, &var }
 
-/* initialize struct */
+/** Initialize empty list head. */
 static inline void list_init(struct List *list)
 {
        list->next = list->prev = list;
 }
 
-/* is list empty? */
+/** Is list empty? */
 static inline int list_empty(const struct List *list)
 {
        return list->next == list;
 }
 
-/* add item to the start of the list */
+/** Add item to the start of the list */
 static inline struct List *list_prepend(struct List *list, struct List *item)
 {
        item->next = list->next;
@@ -51,7 +64,7 @@ static inline struct List *list_prepend(struct List *list, struct List *item)
        return item;
 }
 
-/* add item to the end of the list */
+/** Add item to the end of the list */
 static inline struct List *list_append(struct List *list, struct List *item)
 {
        item->next = list;
@@ -61,7 +74,7 @@ static inline struct List *list_append(struct List *list, struct List *item)
        return item;
 }
 
-/* remove item from list */
+/** Remove item from list */
 static inline struct List *list_del(struct List *item)
 {
        item->prev->next = item->next;
@@ -70,7 +83,7 @@ static inline struct List *list_del(struct List *item)
        return item;
 }
 
-/* remove first from list and return */
+/** Remove first from list and return */
 static inline struct List *list_pop(struct List *list)
 {
        if (list_empty(list))
@@ -78,7 +91,7 @@ static inline struct List *list_pop(struct List *list)
        return list_del(list->next);
 }
 
-/* get first elem from list */
+/** Get first elem from list */
 static inline struct List *list_first(const struct List *list)
 {
        if (list_empty(list))
@@ -86,7 +99,7 @@ static inline struct List *list_first(const struct List *list)
        return list->next;
 }
 
-/* get last elem from list */
+/** Get last elem from list */
 static inline struct List *list_last(const struct List *list)
 {
        if (list_empty(list))
@@ -94,25 +107,31 @@ static inline struct List *list_last(const struct List *list)
        return list->prev;
 }
 
-/* remove first elem from list and return with casting */
+/** Remove first elem from list and return with casting */
 #define list_pop_type(list, typ, field) \
        (list_empty(list) ? NULL \
         : container_of(list_del((list)->next), typ, field))
 
-/* loop over list */
+/** Loop over list */
 #define list_for_each(item, list) \
        for ((item) = (list)->next; \
             (item) != (list); \
             (item) = (item)->next)
 
-/* loop over list and allow removing item */
+/** Loop over list and allow removing item */
 #define list_for_each_safe(item, list, tmp) \
        for ((item) = (list)->next, (tmp) = (list)->next->next; \
             (item) != (list); \
             (item) = (tmp), (tmp) = (tmp)->next)
 
-/* sort list */
+/** Comparator function signature for list_sort() */
 typedef int (*list_cmp_f)(const struct List *a, const struct List *b);
+
+/**
+ * Sort list.
+ *
+ * This implementation uses stable merge sort which operates in-place.
+ */
 void list_sort(struct List *list, list_cmp_f cmp_func);
 
 #endif
index 3ad7319956e8fee13dc4d46b0b8ab500f60bd367..8b66fe61fcf2e7c019412eda436cf6b284c43bb3 100644 (file)
@@ -1,8 +1,16 @@
+/**
+ * @file
+ *
+ * Jenkins' lookup3 non-cryptographic hash.
+ */
 #ifndef _USUAL_LOOKUP3_H_
 #define _USUAL_LOOKUP3_H_
 
 #include <usual/base.h>
 
+/**
+ * Calculate 64-bit hash over data
+ */
 uint64_t hash_lookup3(const void *data, size_t len);
 
 #endif
index 164a02d7acdbcf38743aae92c9572420ef1075a1..a8f8644bb90f6c24119fd76c8fe72c189b36cead 100644 (file)
@@ -1,5 +1,5 @@
 
-/*
+/** \file
  * Safe and easy access to memory buffer.
  */
 
@@ -10,6 +10,7 @@
 
 #include <string.h>
 
+/** MBuf structure.  Allocated by user, can be in stack. */
 struct MBuf {
        uint8_t *data;
        unsigned read_pos;
@@ -19,14 +20,16 @@ struct MBuf {
        bool fixed;
 };
 
-/* helpers for *printf() */
+/** Format fragment for *printf() */
 #define MBUF_FMT       ".*s"
-#define MBUF_ARG(m)    (m) ? mbuf_written(m) : 6, (m) ? (const char *)mbuf_data(m) : "(null)"
+/** Argument layout for *printf() */
+#define MBUF_ARG(m)    ((m) ? mbuf_written(m) : 6), ((m) ? (const char *)mbuf_data(m) : "(null)")
 
 /*
- * Init functions.
+ * Init functions
  */
 
+/** Initialize R/O buffer to fixed memory area. */
 static inline void mbuf_init_fixed_reader(struct MBuf *buf, const void *ptr, unsigned len)
 {
        buf->data = (uint8_t *)ptr;
@@ -37,6 +40,7 @@ static inline void mbuf_init_fixed_reader(struct MBuf *buf, const void *ptr, uns
        buf->fixed = true;
 }
 
+/** Initialize R/W buffer to fixed memory area. */
 static inline void mbuf_init_fixed_writer(struct MBuf *buf, void *ptr, unsigned len)
 {
        buf->data = (uint8_t *)ptr;
@@ -47,6 +51,7 @@ static inline void mbuf_init_fixed_writer(struct MBuf *buf, void *ptr, unsigned
        buf->fixed = true;
 }
 
+/** Initialize R/W buffer to dynamically allocated memory area.  */
 static inline void mbuf_init_dynamic(struct MBuf *buf)
 {
        buf->data = NULL;
@@ -57,6 +62,7 @@ static inline void mbuf_init_dynamic(struct MBuf *buf)
        buf->fixed = false;
 }
 
+/** Free dynamically allocated area, if exists. */
 static inline void mbuf_free(struct MBuf *buf)
 {
        if (buf->data) {
@@ -70,11 +76,13 @@ static inline void mbuf_free(struct MBuf *buf)
  * Reset functions.
  */
 
+/** Move read cursor to start of buffer. */
 static inline void mbuf_rewind_reader(struct MBuf *buf)
 {
        buf->read_pos = 0;
 }
 
+/** Move both read and write cursor to start of buffer. */
 static inline void mbuf_rewind_writer(struct MBuf *buf)
 {
        if (!buf->reader) {
@@ -87,11 +95,13 @@ static inline void mbuf_rewind_writer(struct MBuf *buf)
  * Info functions.
  */
 
+/** How many bytes can be read with read cursor. */
 static inline unsigned mbuf_avail_for_read(const struct MBuf *buf)
 {
        return buf->write_pos - buf->read_pos;
 }
 
+/** How many bytes can be written with write cursor, without realloc. */
 static inline unsigned mbuf_avail_for_write(const struct MBuf *buf)
 {
        if (!buf->reader && buf->alloc_len > buf->write_pos)
@@ -99,16 +109,19 @@ static inline unsigned mbuf_avail_for_write(const struct MBuf *buf)
        return 0;
 }
 
+/** How many data bytes are in buffer. */
 static inline unsigned mbuf_written(const struct MBuf *buf)
 {
        return buf->write_pos;
 }
 
+/** Return pointer to data area. */
 static inline const void *mbuf_data(const struct MBuf *buf)
 {
        return buf->data;
 }
 
+/** Do the mbufs contain same data. */
 static inline bool mbuf_eq(const struct MBuf *buf1, const struct MBuf *buf2)
 {
        if (buf1 == buf2) return true;
@@ -117,6 +130,7 @@ static inline bool mbuf_eq(const struct MBuf *buf1, const struct MBuf *buf2)
        return memcmp(mbuf_data(buf1), mbuf_data(buf2), mbuf_written(buf1)) == 0;
 }
 
+/** Complare mbuf to asciiz string */
 static inline bool mbuf_eq_str(const struct MBuf *buf1, const char *s)
 {
        struct MBuf tmp;
@@ -128,6 +142,7 @@ static inline bool mbuf_eq_str(const struct MBuf *buf1, const char *s)
  * Read functions.
  */
 
+/** Read a byte from read cursor. */
 _MUSTCHECK
 static inline bool mbuf_get_byte(struct MBuf *buf, uint8_t *dst_p)
 {
@@ -137,6 +152,7 @@ static inline bool mbuf_get_byte(struct MBuf *buf, uint8_t *dst_p)
        return true;
 }
 
+/** Read big-endian uint16 from read cursor. */
 _MUSTCHECK
 static inline bool mbuf_get_char(struct MBuf *buf, char *dst_p)
 {
@@ -158,6 +174,7 @@ static inline bool mbuf_get_uint16be(struct MBuf *buf, uint16_t *dst_p)
        return true;
 }
 
+/** Read big-endian uint32 from read cursor. */
 _MUSTCHECK
 static inline bool mbuf_get_uint32be(struct MBuf *buf, uint32_t *dst_p)
 {
@@ -172,6 +189,7 @@ static inline bool mbuf_get_uint32be(struct MBuf *buf, uint32_t *dst_p)
        return true;
 }
 
+/** Get reference to len bytes from read cursor. */
 _MUSTCHECK
 static inline bool mbuf_get_uint64be(struct MBuf *buf, uint64_t *dst_p)
 {
@@ -193,6 +211,7 @@ static inline bool mbuf_get_bytes(struct MBuf *buf, unsigned len, const uint8_t
        return true;
 }
 
+/** Get reference to asciiz string from read cursor. */
 _MUSTCHECK
 static inline bool mbuf_get_chars(struct MBuf *buf, unsigned len, const char **dst_p)
 {
@@ -219,9 +238,11 @@ static inline bool mbuf_get_string(struct MBuf *buf, const char **dst_p)
  * Write functions.
  */
 
+/** Allocate more room if needed and the mbuf allows. */
 _MUSTCHECK
 bool mbuf_make_room(struct MBuf *buf, unsigned len);
 
+/** Write a byte to write cursor. */
 _MUSTCHECK
 static inline bool mbuf_write_byte(struct MBuf *buf, uint8_t val)
 {
@@ -232,6 +253,7 @@ static inline bool mbuf_write_byte(struct MBuf *buf, uint8_t val)
        return true;
 }
 
+/** Write len bytes to write cursor. */
 _MUSTCHECK
 static inline bool mbuf_write(struct MBuf *buf, const void *ptr, unsigned len)
 {
@@ -243,14 +265,14 @@ static inline bool mbuf_write(struct MBuf *buf, const void *ptr, unsigned len)
        return true;
 }
 
-/* writes full contents of another mbuf, without touching it */
+/** writes full contents of another mbuf, without touching it */
 _MUSTCHECK
 static inline bool mbuf_write_raw_mbuf(struct MBuf *dst, struct MBuf *src)
 {
        return mbuf_write(dst, src->data, src->write_pos);
 }
 
-/* writes partial contents of another mbuf, with touching it */
+/** writes partial contents of another mbuf, with touching it */
 _MUSTCHECK
 static inline bool mbuf_write_mbuf(struct MBuf *dst, struct MBuf *src, unsigned len)
 {
@@ -264,6 +286,7 @@ static inline bool mbuf_write_mbuf(struct MBuf *dst, struct MBuf *src, unsigned
        return true;
 }
 
+/** Fiil mbuf with byte value */
 _MUSTCHECK
 static inline bool mbuf_fill(struct MBuf *buf, uint8_t byte, unsigned len)
 {
@@ -275,7 +298,7 @@ static inline bool mbuf_fill(struct MBuf *buf, uint8_t byte, unsigned len)
        return true;
 }
 
-/* remove some data from buf */
+/** remove some data from mbuf */
 _MUSTCHECK
 static inline bool mbuf_cut(struct MBuf *buf, unsigned ofs, unsigned len)
 {
index 685d40933522253002939fcbf6afc50f19a7a808..4ba03f3d2fca66f178aed3b47da30ae19f789d2b 100644 (file)
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
 
+/**
+ * @file
+ *
+ * MD5 cryptographic hash.
+ */
+
 #ifndef _USUAL_MD5_H_
 #define _USUAL_MD5_H_
 
 #include <usual/base.h>
 
+/** Block length for MD5 */
 #define MD5_BLOCK_LENGTH       64
+
+/** Result length for MD5 */
 #define MD5_DIGEST_LENGTH      16
 
+/** MD5 state */
 struct md5_ctx {
        uint64_t nbytes;
        uint32_t a, b, c, d;
        uint32_t buf[16];
 };
 
+/** Clean state */
 void md5_reset(struct md5_ctx *ctx);
+
+/** Update state with more data */
 void md5_update(struct md5_ctx *ctx, const void *data, unsigned int len);
+
+/** Get final result */
 void md5_final(uint8_t *dst, struct md5_ctx *ctx);
 
 #ifdef MD5_COMPAT
index 183e4efc37d7ae87f1a753c008bbac468fd34dfe..d7919026ce342583ce2bac6ec4436cfd3d984113 100644 (file)
@@ -1,6 +1,4 @@
 /*
- * Simple memory pool for variable-length allocations.
- *
  * Copyright (c) 2009 Marko Kreen
  *
  * Permission to use, copy, modify, and/or distribute this software for any
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
 
+/**
+ * @file
+ * Simple memory pool for variable-length allocations.
+ */
 #ifndef _USUAL_MEMPOOL_H_
 #define _USUAL_MEMPOOL_H_
 
 #include <usual/base.h>
 
+/** Pool Reference */
 struct MemPool;
 
+/** Allocate from pool */
 void *mempool_alloc(struct MemPool **pool, unsigned size) _MALLOC;
+
+/** Release all memory in pool */
 void mempool_destroy(struct MemPool **pool);
 
 #endif
index 822eb3f7efa3da291a411bc18f17e83a80604b92..f6a8a9b00f8fabe6c40da160b37868804725f730 100644 (file)
@@ -1,14 +1,44 @@
+/*
+ * libusual - Utility library for C
+ *
+ * Copyright (c) 2007-2009  Marko Kreen, Skype Technologies OÜ
+ *
+ * Permission to use, copy, modify, and/or distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ */
 
+/**
+ * @file
+ *
+ * Utility functions for PostgreSQL data formats.
+ */
 #ifndef _USUAL_PGUTIL_H_
 #define _USUAL_PGUTIL_H_
 
 #include <usual/string.h>
 
+/** Check if string is reserver word for PostgreSQL. */
 bool pg_is_reserved_word(const char *str);
 
+/** Quote value as string for PostgreSQL */
 bool pg_quote_literal(char *_dst, const char *_src, int dstlen);
+
+/** Quote value as ident for PostgreSQL */
 bool pg_quote_ident(char *_dst, const char *_src, int dstlen);
+
+/** Quote fully-qualified ident for PostgreSQL */
 bool pg_quote_fqident(char *_dst, const char *_src, int dstlen);
+
+/** Parse PostgreSQL array. */
 struct StrList *pg_parse_array(const char *pgarr, CxMem *cx);
 
 #endif
index fab7f3bb472f223808621f9ce93059d9136851f9..049e1891c97609d4f54b8c67ba39c09f39c71ad8 100644 (file)
@@ -23,7 +23,8 @@
 
 #ifdef HAVE_PTHREAD_H
 #include <pthread.h>
-#endif
+
+#else
 
 #ifdef WIN32
 
@@ -47,4 +48,6 @@ int pthread_join(pthread_t *t, void **ret);
 
 #endif /* WIN32 */
 
+#endif /* HAVE_PTHREAD_H */
+
 #endif
index f2d4506424c5ea848cf04474abdf64ec1a6da8ab..6399a36a2bb80f791e87a8515a82c27f5139c6e5 100644 (file)
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
 
+/**
+ * @file
+ *
+ * POSIX regular expession API, provided by either libc or internally.
+ *
+ * The internal regex engine is only activated if OS does not provide
+ * @ref regex_links "<regex.h>" (eg. Windows) or if
+ * --with-internal-regex is used when configuring @ref libusual.
+ *
+ * @section uregex  Internal regex features.
+ *
+ * Simple recursive matcher, only features are small size
+ * and POSIX compatibility.
+ *
+ * @code
+ *   ERE syntax: . * ^ $ [] [[:cname:]] () {} | + ?
+ *   BRE syntax: . * ^ $ [] [[:cname:]] \(\) \{\} \1-9
+ * @endcode
+ *
+ * With REG_RELAXED_SYNTAX, following common escapes will be available:
+ * @code
+ *    Both: \b\B\d\D\s\S\w\W
+ *    BRE:  \|
+ *    ERE:  \1-9
+ * @endcode
+ *
+ * With REG_RELAXED_MATCHING it returns the first match found after applying
+ * leftmost-longest to all elements.  It skips the combinatorics to turn it
+ * into guaranteed-longest match.
+ *
+ * @section skip Skipped POSIX features
+ * - collation classes: [[. .]]
+ * - equivalence classes: [[= =]]
+ * - char ranges by locale order: [a-z]  (byte order will be used)
+ * - multi-byte chars: UTF-8
+ *
+ * @section globaldefs Global defines
+ * - USUAL_RELAXED_REGEX
+ * - USE_INTERNAL_REGEX
+ *
+ * @section regex_links  Compatibility
+ *
+ * - <a href="http://www.opengroup.org/onlinepubs/9699919799/basedefs/regex.h.html">
+ *   POSIX-2008 <regex.h> spec</a> - by default uRegex run in mode where only
+ *   features specified by POSIX are available.
+ *
+ * - <a href="http://www2.research.att.com/~gsf/testregex/">
+ *   AT\&T Research regex(3) regression tests</a> - uRegex follows the interpretation
+ *   given there and fully passes the testsuite.
+ */
+
+
 #ifndef _USUAL_REGEX_H_
 #define _USUAL_REGEX_H_
 
  * uRegex defines
  */
 
-/* flags to regcomp() */
+/**
+ * @name Standard flags to regcomp()
+ * @{
+ */
+
+/** Use POSIX Extended Regex Syntax instead of Basic Syntax */
 #define REG_EXTENDED   (1 << 0)
+
+/** Do case-insensitive matching */
 #define REG_ICASE      (1 << 1)
+
+/** Do case-insensitive matching */
 #define REG_NOSUB      (1 << 2)
+
+/** Do case-insensitive matching */
 #define REG_NEWLINE    (1 << 3)
 
-/* flags to regexec() */
+/* @} */
+
+/**
+ * @name Standard flags to regexec()
+ * @{
+ */
+
+/** The start of string is not beginning of line, so ^ should not match */
 #define REG_NOTBOL     (1 << 4)
+
+/** The end of string is not end of line, so $ should not match */
 #define REG_NOTEOL     (1 << 5)
 
-/* error codes */
+/* @} */
+
+/**
+ * @name Standard error codes
+ * @{
+ */
+/** Match not found */
 #define REG_NOMATCH    1
+/** Bad {} repeat specification */
 #define REG_BADBR      2
+/** General problem with regular expression */
 #define REG_BADPAT     3
+/** Repeat used without preceding non-repeat element */
 #define REG_BADRPT     4
+/** Syntax error with {} */
 #define REG_EBRACE     5
+/** Syntax error with [] */
 #define REG_EBRACK     6
+/** Bad collation reference */
 #define REG_ECOLLATE   7
+/** Bad character class reference  */
 #define REG_ECTYPE     8
+/** ------------- */
 #define REG_EEND       9
+/** Trailing backslack */
 #define REG_EESCAPE    10
+/** Syntax error with () */
 #define REG_EPAREN     11
+/** Bad endpoint in range */
 #define REG_ERANGE     12
+/** ----------------- */
 #define REG_ESIZE      13
+/** No memory */
 #define REG_ESPACE     14
+/** Bad subgroup reference */
 #define REG_ESUBREG    15
 
-/* max count user can enter via {} */
+/* @} */
+
+/**
+ * @name Other defines
+ * @{
+ */
 #undef RE_DUP_MAX
+/** Max count user can enter via {} */
 #define RE_DUP_MAX     0x7ffe
+/* @} */
 
-/*
- * Local flags to regcomp()
+/**
+ * @name Non-standard defines for regcomp()
+ * @{
  */
 
-/* allow \b\B\d\D\s\S\w\W\/ */
+/**
+ * Allow few common non-standard escapes:
+ * @code
+ *   \b - word-change
+ *   \B - not word change
+ *   \d - digit
+ *   \D - non-digit
+ *   \s - space
+ *   \S - non-space
+ *   \w - word char
+ *   \W - non-word char
+ *   \/ - /
+ * @endcode
+ */
 #define REG_RELAXED_SYNTAX     (1 << 14)
 
-/* dont permute groups in attempt to get longest match */
+/**
+ * Dont permute groups in attempt to get longest match.
+ *
+ * May give minor speed win at the expense of strict POSIX compat.
+ */
 #define REG_RELAXED_MATCHING   (1 << 15)
 
-/* turn both on */
+/** Turn on both REG_RELAXED_SYNTAX and REG_RELAXED_MATCHING */
 #define REG_RELAXED            (REG_RELAXED_SYNTAX | REG_RELAXED_MATCHING)
 
+/* @} */
+
 /* turn them permanently on */
 #ifdef USUAL_RELAXED_REGEX
 #undef REG_EXTENDED
 #define REG_EXTENDED (1 | REG_RELAXED)
 #endif
 
-/* compiled regex */
+
+/**
+ * Compiled regex.
+ *
+ * It has only one standard field - re_nsub,
+ * rest are implementation-specific.
+ */
 typedef struct {
+       /** Number of subgroups in expression */
        int re_nsub;
        void *internal;
 } regex_t;
 
-/* match location */
+/** Type for offset in match */
 typedef long regoff_t;
+
+/** Match location */
 typedef struct {
-       regoff_t rm_so;
-       regoff_t rm_eo;
+       regoff_t rm_so;         /**<  Start offset */
+       regoff_t rm_eo;         /**<  End offset   */
 } regmatch_t;
 
 /* avoid name conflicts */
@@ -104,9 +232,41 @@ typedef struct {
 #define regfree(a) usual_regfree(a)
 
 /* public functions */
+
+/**
+ * Compile regex.
+ *
+ * @param rx    Pre-allocated @ref regex_t structure to fill.
+ * @param re    Regex as zero-terminated string.
+ * @param flags See bove for regcomp() flags.
+ */
 int regcomp(regex_t *rx, const char *re, int flags);
+
+/**
+ * Execute regex on string.
+ *
+ * @param rx      Regex previously filled by regcomp()
+ * @param str     Zero-terminated string to match
+ * @param nmatch  number of matches in pmatch
+ * @param pmatch  Array of matches.
+ * @param eflags  Execution flags.  Supported flags: @ref REG_NOTBOL, @ref REG_NOTEOL
+ */
 int regexec(const regex_t *rx, const char *str, size_t nmatch, regmatch_t pmatch[], int eflags);
+
+/**
+ * Give error description.
+ *
+ * @param err  Error code returned by regcomp() or regexec()
+ * @param rx   Regex structure used in regcomp() or regexec()
+ * @param dst  Destination buffer
+ * @param dstlen Size of dst
+ */
 size_t regerror(int err, const regex_t *rx, char *dst, size_t dstlen);
+
+/**
+ * Free resources allocated by regcomp().
+ * \param rx Regex previously filled by regcomp()
+ */
 void regfree(regex_t *rx);
 
 #endif /* !USE_SYSTEM_REGEX */
index 13d15ce6fbb25b35aa4452a1f41c03290c38f928..09dbdf3c1ef23b3b0ac6c1440dab179ef0aecb53 100644 (file)
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
 
+/**
+ * @file
+ *
+ * SHA1 implementation.
+ */
+
 #ifndef _USUAL_SHA1_H_
 #define _USUAL_SHA1_H_
 
 #include <usual/base.h>
 
+/** Block length for SHA1 */
 #define SHA1_BLOCK_SIZE                64
+
+/** Result length for SHA1 */
 #define SHA1_DIGEST_LENGTH     20
 
+
+/** SHA1 state */
 struct sha1_ctx {
        uint64_t nbytes;
        uint32_t a, b, c, d, e;
        uint32_t buf[SHA1_BLOCK_SIZE / 4];
 };
 
+/** Clean state */
 void sha1_reset(struct sha1_ctx *ctx);
+
+/** Update state with more data */
 void sha1_update(struct sha1_ctx *ctx, const void *data, unsigned int len);
+
+/** Get final result */
 void sha1_final(uint8_t *dst, struct sha1_ctx *ctx);
 
 #ifndef AVOID_SHA1_COMPAT
index 1b9060a14c0be32aa637f6a6f3932c4862fcf725..8fe5c2fc545b6909d2cb33a57efc0d77897aee37 100644 (file)
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
 
+/**
+ * @file
+ *
+ * Circular list for shared mem.
+ *
+ * Instead of pointers, it uses offsets from list head.
+ */
 #ifndef _USUAL_SHLIST_H_
 #define _USUAL_SHLIST_H_
 
 #include <usual/base.h>
 
+/** List node/head.  Uses offsets from head instead of direct pointers. */
 struct SHList {
-       uintptr_t next, prev;
+       /** Offset to next elem */
+       uintptr_t next;
+       /** Offset from next elem */
+       uintptr_t prev;
 };
 
 /*
@@ -47,13 +58,14 @@ static inline void *_sh2ptr(const void *base, uintptr_t sh)
  * List operations.
  */
 
+/** Initialize list head */
 static inline void shlist_init(struct SHList *list)
 {
        list->next = _ptr2sh(list, list);
        list->prev = _ptr2sh(list, list);
 }
 
-/* insert as last element */
+/** Insert as last element */
 static inline void shlist_append(struct SHList *list, struct SHList *item)
 {
        struct SHList *last = _sh2ptr(list, list->prev);
@@ -63,7 +75,7 @@ static inline void shlist_append(struct SHList *list, struct SHList *item)
        last->next = _ptr2sh(list, item);
 }
 
-/* insert as first element */
+/** Insert as first element */
 static inline void shlist_prepend(struct SHList *list, struct SHList *item)
 {
        struct SHList *first = _sh2ptr(list, list->prev);
@@ -73,7 +85,7 @@ static inline void shlist_prepend(struct SHList *list, struct SHList *item)
        first->prev = _ptr2sh(list, item);
 }
 
-/* remove an item */
+/** Remove an item */
 static inline void shlist_remove(struct SHList *list, struct SHList *item)
 {
        struct SHList *next = _sh2ptr(list, item->next);
@@ -83,13 +95,13 @@ static inline void shlist_remove(struct SHList *list, struct SHList *item)
        item->next = item->prev = 0; /*  _ptr2sh(list, item) does not make sense here; */
 }
 
-/* no elements? */
+/** No elements? */
 static inline bool shlist_empty(const struct SHList *list)
 {
        return list->next == list->prev;
 }
 
-/* return first elem */
+/** Return first elem */
 static inline struct SHList *shlist_first(const struct SHList *list)
 {
        if (shlist_empty(list))
@@ -97,7 +109,7 @@ static inline struct SHList *shlist_first(const struct SHList *list)
        return _sh2ptr(list, list->next);
 }
 
-/* remove first elem */
+/** Remove first elem */
 static inline struct SHList *shlist_pop(struct SHList *list)
 {
        struct SHList *item = shlist_first(list);
@@ -106,17 +118,17 @@ static inline struct SHList *shlist_pop(struct SHList *list)
        return item;
 }
 
-/* remove specific type of elem */
+/** Remove and return specific type of elem */
 #define shlist_pop_type(list, type, field) ( \
        shlist_empty(list) ? NULL : container_of(shlist_pop(list), type, field))
 
-/* loop over list */
+/** Loop over list */
 #define shlist_for_each(item, list) \
        for ((item) = _sh2ptr((list), (list)->next); \
             (item) != (list); \
             (item) = _sh2ptr((list), (item)->next))
 
-/* loop over list and allow removing item */
+/** Loop over list and allow removing item */
 #define shlist_for_each_safe(item, list, tmp) \
        for ((item) = _sh2ptr((list), (list)->next), \
              (tmp) = _sh2ptr((list), (item)->next); \
index 20a1ad373d287985375c38df327749c3150ce734..d79e21e79eaade0f73646c7b83ae61fd874671d3 100644 (file)
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
 
-/*
- * Basic behaviour:
- * - On each alloc initializer is called.
- * - if init func is not given, memset() is done
- * - init func gets either zeroed obj or old obj from _free().
- *   'struct List' on obj start is non-zero.
- *
- * ATM custom 'align' larger than malloc() alignment does not work.
- */
-
 #include <usual/slab.h>
 
 #include <string.h>
index 0c1660cde6faac17fa5b3c2e55319ba4821d5408..77d4fd4e7b6f95d679495f979ff8b71c63d76070 100644 (file)
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
 
+/**
+ * @file
+ *
+ * Slab allocator for same-size objects.
+ *
+ * Basic behaviour:
+ * - On each alloc initializer is called.
+ * - if init func is not given, memset() is done
+ * - init func gets either zeroed obj or old obj from _free().
+ *   'struct List' on obj start is non-zero.
+ *
+ * ATM custom 'align' larger than malloc() alignment does not work.
+ */
 #ifndef _USUAL_SLAB_H_
 #define _USUAL_SLAB_H_
 
 #include <usual/cxalloc.h>
 
+/** Reference to main */
 struct Slab;
 
+/** Signature for object init function */
 typedef void (*slab_init_fn)(void *obj);
 
+/** Create new slab context for specific size */
 struct Slab *slab_create(const char *name, unsigned obj_size, unsigned align,
                             slab_init_fn init_func,
                             CxMem *cx);
+
+/** Free whole context */
 void slab_destroy(struct Slab *slab);
 
-void * slab_alloc(struct Slab *slab) _MALLOC _MUSTCHECK;
+/** Allocate single object from slab cache */
+void *slab_alloc(struct Slab *slab) _MALLOC _MUSTCHECK;
+
+/** Release single object back */
 void slab_free(struct Slab *slab, void *obj);
 
+/** Return sum of free and used objects */
 int slab_total_count(const struct Slab *slab);
+
+/** Return number of free objects in cache */
 int slab_free_count(const struct Slab *slab);
+
+/** Return number of used objects */
 int slab_active_count(const struct Slab *slab);
 
+/** Signature for stat info callback */
 typedef void (*slab_stat_fn)(void *arg, const char *slab_name,
                             unsigned size, unsigned free, 
                             unsigned total);
+
+/** Run stat info callback on all slabs */
 void slab_stats(slab_stat_fn cb_func, void *cb_arg);
 
 #endif
index eca9d630e3de4a7db3ba88b3e81538ebad891d88..070cd7f9559ed2290b7209c1a98df97456239c29 100644 (file)
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
 
+/**
+ * @file
+ *
+ * Circular list that keep track of stats about the list.
+ *
+ * Currenly only count of abjects currently in list
+ * is kept track of.  The plan was to track more,
+ * like max, but it was not useful enough.
+ */
 #ifndef _USUAL_STATLIST_H_
 #define _USUAL_STATLIST_H_
 
 #include <usual/list.h>
 
+/**
+ * Header structure for StatList.
+ */
 struct StatList {
+       /** Actual list head */
        struct List head;
+       /** Count of objects currently in list */
        int cur_count;
 #ifdef LIST_DEBUG
+       /** List name */
        const char *name;
 #endif
 };
 
+/** Define and initialize StatList head */
 #ifdef LIST_DEBUG
 #define STATLIST(var) struct StatList var = { {&var.head, &var.head}, 0, #var }
 #else
 #define STATLIST(var) struct StatList var = { {&var.head, &var.head}, 0 }
 #endif
 
+/** Add to the start of the list */
 static inline void statlist_prepend(struct StatList *list, struct List *item)
 {
        list_prepend(&list->head, item);
        list->cur_count++;
 }
 
+/** Add to the end of the list */
 static inline void statlist_append(struct StatList *list, struct List *item)
 {
        list_append(&list->head, item);
        list->cur_count++;
 }
 
+/** Remove element from the list */
 static inline void statlist_remove(struct StatList *list, struct List *item)
 {
        list_del(item);
@@ -55,6 +74,7 @@ static inline void statlist_remove(struct StatList *list, struct List *item)
        //Assert(list->cur_count >= 0);
 }
 
+/** Initialize StatList head */
 static inline void statlist_init(struct StatList *list, const char *name)
 {
        list_init(&list->head);
@@ -64,12 +84,14 @@ static inline void statlist_init(struct StatList *list, const char *name)
 #endif
 }
 
+/** return number of elements currently in list */
 static inline int statlist_count(const struct StatList *list)
 {
        //Assert(list->cur_count > 0 || list_empty(&list->head));
        return list->cur_count;
 }
 
+/** remove and return first element */
 static inline struct List *statlist_pop(struct StatList *list)
 {
        struct List *item = list_pop(&list->head);
@@ -82,25 +104,32 @@ static inline struct List *statlist_pop(struct StatList *list)
        return item;
 }
 
+/** Return first element */
 static inline struct List *statlist_first(const struct StatList *list)
 {
        return list_first(&list->head);
 }
 
+/** Is list empty */
 static inline bool statlist_empty(const struct StatList *list)
 {
        return list_empty(&list->head);
 }
 
+/** Loop over list */
 #define statlist_for_each(item, list) list_for_each(item, &((list)->head))
+
+/** Loop over list safely, so that elements can be removed during */
 #define statlist_for_each_safe(item, list, tmp) list_for_each_safe(item, &((list)->head), tmp)
 
+/** Put intem before another */
 static inline void statlist_put_before(struct StatList *list, struct List *item, struct List *pos)
 {
        list_append(pos, item);
        list->cur_count++;
 }
 
+/** Put item after another */
 static inline void statlist_put_after(struct StatList *list, struct List *item, struct List *pos)
 {
        list_prepend(pos, item);
index e9fcc3f186dbc506e35525179e572feb53cd1521..3381441ab06c9bff817ec83f7fe36c2b28a6ecec 100644 (file)
@@ -1,6 +1,4 @@
 /*
- * Theme include for strings.
- * 
  * Copyright (c) 2007-2009  Marko Kreen, Skype Technologies OÜ
  * 
  * Permission to use, copy, modify, and/or distribute this software for any
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
 
+/**
+ * \file
+ * Theme include for strings.
+ */
+
 #ifndef _USUAL_STRING_H_
 #define _USUAL_STRING_H_
 
 #include <libgen.h>
 #endif
 
-#ifndef HAVE_STRLCPY
-#define strlcpy(a,b,c) usual_strlcpy(a,b,c)
-size_t strlcpy(char *dst, const char *src, size_t n);
-#endif
-
-#ifndef HAVE_STRLCAT
-#define strlcat(a,b,c) usual_strlcat(a,b,c)
-size_t strlcat(char *dst, const char *src, size_t n);
-#endif
-
-#ifndef HAVE_MEMRCHR
-#define memrchr(a,b,c) usual_memrchr(a,b,c)
-void *memrchr(const void *s, int c, size_t n);
-#endif
+/**
+ * @name  List of strings.
+ * @{
+ */
 
+/** Callback signature */
 typedef bool (*str_cb)(void *arg, const char *s);
 
 struct StrList;
+/** Allocate new string list */
 struct StrList *strlist_new(CxMem *ca);
+/** Free string string */
 void strlist_free(struct StrList *slist);
+/** Check if empty */
 bool strlist_empty(struct StrList *slist);
+/** Append copy of string. */
 bool strlist_append(struct StrList *slist, const char *str);
+/** Append reference, strlist now owns it. */
 bool strlist_append_ref(struct StrList *slist, const char *str);
+/** Call function on each element */
 bool strlist_foreach(const struct StrList *slist, str_cb cb_func, void *cb_arg);
+/** Remove and return first element */
 const char *strlist_pop(struct StrList *slist);
+/* @} */
 
+/** Parse comma-separated elements from string and launch callback for each of them. */
 bool parse_word_list(const char *s, str_cb cb_func, void *cb_arg);
 
+#ifndef HAVE_STRLCPY
+#define strlcpy(a,b,c) usual_strlcpy(a,b,c)
+/** Compat: Safely copy string to fixed-length buffer.  */
+size_t strlcpy(char *dst, const char *src, size_t n);
+#endif
+
+#ifndef HAVE_STRLCAT
+#define strlcat(a,b,c) usual_strlcat(a,b,c)
+/** Compat: Safely append string to fixed-length buffer. */
+size_t strlcat(char *dst, const char *src, size_t n);
+#endif
+
 /*
  * fls(int)
  * flsl(long)
@@ -76,12 +91,15 @@ bool parse_word_list(const char *s, str_cb cb_func, void *cb_arg);
 #endif
 
 #ifndef HAVE_FLS
+/** Compat: Find last (MSB) set bit, 1-based ofs, 0 if arg == 0 */
 static inline int fls(int x) { _FLS(, int); }
 #endif
 #ifndef HAVE_FLSL
+/** Compat: Find last (MSB) set bit, 1-based ofs, 0 if arg == 0 */
 static inline int flsl(long x) { _FLS(l, long); }
 #endif
 #ifndef HAVE_FLSLL
+/** Compat: Find last (MSB) set bit, 1-based ofs, 0 if arg == 0 */
 static inline int flsll(long long x) { _FLS(ll, long long); }
 #endif
 #undef _FLS
@@ -90,6 +108,7 @@ static inline int flsll(long long x) { _FLS(ll, long long); }
 #ifndef HAVE_BASENAME
 #undef basename
 #define basename(a) usual_basename(a)
+/** Compat: Return pointer to last non-path element */
 const char *basename(const char *path);
 #endif
 
@@ -105,11 +124,12 @@ const char *dirname(const char *path);
 
 #ifdef WIN32
 const char *win32_strerror(int e);
+/** Compat: strerror() for win32 */
 #define strerror(x) win32_strerror(x)
 #endif
 
-/* convert native strerror_r() to GNU signature */
 const char *usual_strerror_r(int e, char *dst, size_t dstlen);
+/** Compat: Provide GNU-style API: const char *strerror_r(int e, char *dst, size_t dstlen)  */
 #define strerror_r(a,b,c) usual_strerror_r(a,b,c)
 
 #endif
index 2cf13e2aadbfd344077ee94626827454ad02e9b0..085883fd46a7b2425d813afbc700c8f1168101d2 100644 (file)
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
 
+/**
+ * @file
+ *
+ * Storage for shared strings.
+ *
+ * This provides refcounted searchable string pool for cases
+ * where lot of objects reference same strings.
+ */
+
 #ifndef _USUAL_STRPOOL_H_
 #define _USUAL_STRPOOL_H_
 
 #include <usual/cxalloc.h>
 
+/** Handle for the pool */
 struct StrPool;
 
-/* Pooled String */
+/** Pooled String */
 struct PStr {
+       /** Parent pool */
        struct StrPool *pool;
+       /** Reference count */
        int refcnt;
+       /** String length */
        int len;
+       /** Zero-terminated value */
        char str[];
 };
 
-
+/** Create new pool */
 struct StrPool *strpool_create(CxMem *ca);
+
+/** Release pool */
 void strpool_free(struct StrPool *sp);
 
+/** Return either existing or new PStr for given value */
 struct PStr *strpool_get(struct StrPool *sp, const char *str, int len);
 
+/** Increase reference count for existing PStr */
 void strpool_incref(struct PStr *str);
+
+/** Decrease reference count for existing PStr */
 void strpool_decref(struct PStr *str);
 
+/** Return count of strings in the pool */
 int strpool_total(struct StrPool *sp);
 
 #endif
index 21a33b7f9b06fee018bfddc46f3ea0739456b550..46ef86f11a6ab1728f540c0e6f0eb908c2cf1c50 100644 (file)
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */ 
 
+/** * @file
+ *
+ * Time-related functionality.
+ */
+
 #ifndef _USUAL_TIME_H_
 #define _USUAL_TIME_H_
 
 #include <sys/time.h>
 #include <time.h>
 
+/** Type to hold microseconds. */
 typedef uint64_t usec_t;
+
+/** How many microseconds in a second. */
 #define USEC 1000000ULL
 
+/** Convert usec timestamp to ISO timestamp with millisecond precision: YYYY-mm-dd hh:mm:ss.SSS */
 char *format_time_ms(usec_t time, char *dst, unsigned dstlen);
+/** Convert usec timestamp to ISO timestamp with second precision: YYYY-mm-dd hh:mm:ss */
 char *format_time_s(usec_t time, char *dst, unsigned dstlen);
 
+/** Query system time */
 usec_t get_time_usec(void);
+
+/** Query cached system time */
 usec_t get_cached_time(void);
+/** Forget cached system time, next call will fill it. */
 void reset_time_cache(void);
 
 #ifdef WIN32
+/** Compat: gettimeofday() */
 int gettimeofday(struct timeval * tp, void * tzp);
+/** Compat: localtime_r() */
 struct tm *localtime_r(const time_t *tp, struct tm *buf);
 
 #ifndef HAVE_USLEEP
+/** Compat: usleep() */
 static inline void usleep(long usec) { Sleep(usec / 1000); }
 #endif
 
+/** Compat: rusage for win32 */
 struct rusage {
        struct timeval ru_utime;
        struct timeval ru_stime;
 };
 
 #define RUSAGE_SELF 0
+/** Compat: getrusage() for win32 */
 int getrusage(int who, struct rusage *dst);
 
 #endif
index 8e748eda5215e9680a7d68a617e343d586fc2c93..30028692a44ab46cf1926c46aed1d2fe5d063115 100644 (file)
@@ -1,6 +1,8 @@
-/*
+/** @file
  * Low-level UTF8 handling.
- *
+ */
+
+/*
  * Copyright (c) 2009  Marko Kreen
  *
  * Permission to use, copy, modify, and/or distribute this software for any
 
 #include <usual/base.h>
 
+/**
+ * Parse Unicode codepoint from UTF8 stream.
+ *
+ * On invalid UTF8 sequence returns negative byte value and
+ * inreases src_p by one.
+ *
+ * @param src_p Location of data pointer.  Will be incremented in-place.
+ * @param srcend  Pointer to end of data.
+ * @return UNOCODE codepoint or negative byte value on error.
+ */
 int  utf8_get_char(const char **src_p, const char *srcend);
 
+/**
+ * Write Unicode codepoint as UTF8 sequence.
+ *
+ * Skips invalid Unicode values without error.
+ *
+ * @param c       Unicode codepoint.
+ * @param dst_p   Location of dest pointer, will be increased in-place.
+ * @param dstend  Pointer to end of buffer.
+ * @return false if not room, true otherwise.
+ */
 bool utf8_put_char(int c, char **dst_p, const char *dstend);
 
+/** Return UTF8 seq length based on unicode codepoint */
 int utf8_char_size(int c);
+
+/** Return UTF8 seq length based on first byte */
 int utf8_seq_size(unsigned char c);
 
 #endif