diff --git a/TODO.t2t b/TODO.t2t index a633c03..883d6f5 100644 --- a/TODO.t2t +++ b/TODO.t2t @@ -5,7 +5,7 @@ Work to do in OwlPS = Documentation = -- Generalise the use of Doxygen, at least in the libraries. +- Doxygen: solve problem with structs (member fields are not documented). - Topics to write on: - Architecture diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index c205e97..1d8bb75 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -47,3 +47,39 @@ endfunction() add_manpage(owlps 7) add_manpage(owlps-architecture 7) add_manpage(owlps-client 1) + + +### Doxygen-generated man pages ### + +if (NOT DOXYGEN_FOUND) + message(WARNING + "Couldn't find Doxygen: disabling generation of Doxygen-based man pages") + return() +endif() + +# Base output directory for Doxygen (it will append "man" for the +# man pages, "html" for the HTML output, etc.) +set(DOXYGEN_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}") +# Section of the man pages we generate +set(SECTION 3) +# Final output directory (as assembled by Doxygen) +set(OUTPUT_DIRECTORY "${DOXYGEN_OUTPUT_DIRECTORY}/man/man${SECTION}") +# Output files +set(DOXYGEN_MANPAGES "${OUTPUT_DIRECTORY}/owlps.h.${SECTION}" "${OUTPUT_DIRECTORY}/owlps-client.h.${SECTION}" "${OUTPUT_DIRECTORY}/owlps-resultreader.h.${SECTION}") +# Doxygen configuration file name +set(DOXYFILE Doxyfile) + +add_custom_command( + OUTPUT ${DOXYGEN_MANPAGES} + COMMAND DOXYGEN_OUTPUT_DIRECTORY=${DOXYGEN_OUTPUT_DIRECTORY} DOXYGEN_MAN_EXTENSION=.${SECTION} OWLPS_VERSION=${OWLPS_VERSION} "${DOXYGEN_EXECUTABLE}" "${DOXYFILE}" + WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}" + COMMENT "Generating Doxygen-based man pages") + +add_custom_target(doc_doxygen true DEPENDS ${DOXYGEN_MANPAGES}) +add_dependencies(doc doc_doxygen) + +# Clean Doxygen garbage +file(GLOB DOXYGEN_GARBAGE "${OUTPUT_DIRECTORY}/_*_owlps_libowlps*_.${SECTION}") +if (DOXYGEN_GARBAGE) + file(REMOVE ${DOXYGEN_GARBAGE}) +endif() diff --git a/doc/Doxyfile b/doc/Doxyfile new file mode 100644 index 0000000..355df83 --- /dev/null +++ b/doc/Doxyfile @@ -0,0 +1,1797 @@ +# Doxyfile 1.8.1.2 + +# 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 sequence of words) that should +# identify the project. Note that if you do not use Doxywizard you need +# to put quotes around the project name if it contains spaces. + +PROJECT_NAME = "OwlPS" + +# 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 = $(OWLPS_VERSION) + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer +# a quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "Owl Positioning System" + +# With the PROJECT_LOGO tag one can specify an logo or icon that is +# included in the documentation. The maximum height of the logo should not +# exceed 55 pixels and the maximum width should not exceed 200 pixels. +# Doxygen will copy the logo to the output directory. + +PROJECT_LOGO = + +# 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 = $(DOXYGEN_OUTPUT_DIRECTORY) + +# 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-Cyrillic, 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 = NO + +# 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 if your file system +# 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 = NO + +# 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 = YES + +# 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 = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding +# "class=itcl::class" will allow you to use the command class in the +# itcl::class meaning. + +TCL_SUBST = + +# 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, CSharp, 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 MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all +# comments according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you +# can mix doxygen, HTML, and XML commands with Markdown formatting. +# Disable only in case of backward compatibilities issues. + +MARKDOWN_SUPPORT = YES + +# 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 makes 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 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 the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and +# unions are shown inside the group in which they are included (e.g. using +# @ingroup) instead of on a separate page (for HTML and Man pages) or +# section (for LaTeX and RTF). + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and +# unions with only public data fields will be shown inline in the documentation +# of the scope in which they are defined (i.e. file, namespace, or group +# documentation), provided this scope is documented. If set to NO (the default), +# structs, classes, and unions are shown on a separate page (for HTML and Man +# pages) or section (for LaTeX and RTF). + +INLINE_SIMPLE_STRUCTS = 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 = NO + +# 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 penalty. +# 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 roughly 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 + +# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be +# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given +# their name and scope. Since this can be an expensive process and often the +# same symbol appear multiple times in the code, doxygen keeps a cache of +# pre-resolved symbols. If the cache is too small doxygen will become slower. +# If the cache is too large, memory is wasted. The cache size is given by this +# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, +# corresponding to a cache size of 2^16 = 65536 symbols. + +LOOKUP_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_PACKAGE tag is set to YES all members with package or internal scope will be included in the documentation. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +EXTRACT_STATIC = NO + +# 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 namespaces 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 = YES + +# 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 = YES + +# 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 + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to +# do proper type resolution of all parameters of a function it will reject a +# match between the prototype and the implementation of a member function even +# if there is only one candidate or it is obvious which candidate to choose +# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen +# will still accept a match between prototype and implementation in such cases. + +STRICT_PROTO_MATCHING = 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 macro 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 macros 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 + +# 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 , where is the value of +# the FILE_VERSION_FILTER tag, and 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. To 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 = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files +# containing the references data. This must be a list of .bib files. The +# .bib extension is automatically appended if omitted. Using this command +# requires the bibtex tool to be installed. See also +# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style +# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this +# feature you need bibtex and perl available in the search path. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# 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 + +# The WARN_NO_PARAMDOC option can be enabled 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 = ../libowlps/owlps.h +INPUT += ../libowlps/libowlps.c +INPUT += ../libowlps-client/owlps-client.h +INPUT += ../libowlps-client/libowlps-client.c +INPUT += ../libowlps-resultreader/owlps-resultreader.h +INPUT += ../libowlps-resultreader/libowlps-resultreader.c + +# 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++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh +# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py +# *.f90 *.f *.for *.vhd *.vhdl + +FILE_PATTERNS = + +# 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 = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# 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. +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system 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 , where +# is the value of the INPUT_FILTER tag, and 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 or if +# non of the patterns match the file name, INPUT_FILTER is applied. + +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 + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) +# and it is also possible to disable source filtering for a specific pattern +# using *.ext= (so without naming a filter). This option only has effect when +# FILTER_SOURCE_FILES is enabled. + +FILTER_SOURCE_PATTERNS = + +#--------------------------------------------------------------------------- +# 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, C++ and Fortran 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 = NO + +# 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 = NO + +# 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 = YES + +#--------------------------------------------------------------------------- +# 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 = YES + +# 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 = NO + +# 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. Note that when using a custom header you are responsible +# for the proper inclusion of any scripts and style sheets that doxygen +# needs, which is dependent on the configuration options used. +# It is advised to generate a default header using "doxygen -w html +# header.html footer.html stylesheet.css YourConfigFile" and then modify +# that header. Note that the header is subject to change so you typically +# have to redo this when upgrading to a newer version of doxygen or when +# changing the value of configuration settings such as GENERATE_TREEVIEW! + +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 +# style sheet in the HTML output directory as well, or it will be erased! + +HTML_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that +# the files will be copied as-is; there are no commands or markers available. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. +# Doxygen will adjust the colors in the style sheet and background images +# according to this color. Hue is specified as an angle on a colorwheel, +# see http://en.wikipedia.org/wiki/Hue for more information. +# For instance the value 0 represents red, 60 is yellow, 120 is green, +# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. +# The allowed range is 0 to 359. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of +# the colors in the HTML output. For a value of 0 the output will use +# grayscales only. A value of 255 will produce the most vivid colors. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to +# the luminance component of the colors in the HTML output. Values below +# 100 gradually make the output lighter, whereas values above 100 make +# the output darker. The value divided by 100 is the actual gamma applied, +# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, +# and 100 does not change the gamma. + +HTML_COLORSTYLE_GAMMA = 80 + +# 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_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. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of +# entries shown in the various tree structured indices initially; the user +# can expand and collapse entries dynamically later on. Doxygen will expand +# the tree to such a level that at most the specified number of entries are +# visible (unless a fully collapsed tree already exceeds this amount). +# So setting the number of entries 1 will produce a full collapsed tree by +# default. 0 is a special value representing an infinite number of entries +# and will result in a full expanded tree by default. + +HTML_INDEX_NUM_ENTRIES = 100 + +# 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 + +# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. + +DOCSET_PUBLISHER_NAME = Publisher + +# 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 +# +# Qt Help Project / Custom Filters. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's +# filter section matches. +# +# Qt Help Project / Filter Attributes. + +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 (tabs) +# at top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. Since the tabs have the same information as the +# navigation tree you can set this option to NO if you already set +# GENERATE_TREEVIEW to YES. + +DISABLE_INDEX = NO + +# 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. +# Since the tree basically has the same information as the tab index you +# could consider to set DISABLE_INDEX to NO when enabling this option. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values +# (range [0,1..20]) that doxygen will group on one line in the generated HTML +# documentation. Note that a value of 0 will completely suppress the enum +# values from appearing in the overview section. + +ENUM_VALUES_PER_LINE = 4 + +# 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 + +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open +# links to external symbols imported via tag files in a separate window. + +EXT_LINKS_IN_WINDOW = NO + +# 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 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are +# not supported properly for IE 6.0, but are supported on all modern browsers. +# Note that when changing this option you need to delete any form_*.png files +# in the HTML output before the changes have effect. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax +# (see http://www.mathjax.org) which uses client side Javascript for the +# rendering instead of using prerendered bitmaps. Use this if you do not +# have LaTeX installed or if you want to formulas look prettier in the HTML +# output. When enabled you may also need to install MathJax separately and +# configure the path to it using the MATHJAX_RELPATH option. + +USE_MATHJAX = NO + +# When MathJax is enabled you need to specify the location relative to the +# HTML output directory using the MATHJAX_RELPATH option. The destination +# directory should contain the MathJax.js script. For instance, if the mathjax +# directory is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to +# the MathJax Content Delivery Network so you can quickly see the result without +# installing MathJax. +# However, it is strongly recommended to install a local +# copy of MathJax from http://www.mathjax.org before deployment. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension +# names that should be enabled during MathJax rendering. + +MATHJAX_EXTENSIONS = + +# 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 = YES + +# 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 disadvantages are 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, letter, legal and +# executive. If left blank a4wide will be used. + +PAPER_TYPE = a4 + +# 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 = + +# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for +# the generated latex document. The footer should contain everything after +# the last chapter. If it is left blank doxygen will generate a +# standard footer. Notice: only use this tag if you know what you are doing! + +LATEX_FOOTER = + +# 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 = YES + +# 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 = YES + +# 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 + +# The LATEX_BIB_STYLE tag can be used to specify the style to use for the +# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See +# http://en.wikipedia.org/wiki/BibTeX for more info. + +LATEX_BIB_STYLE = plain + +#--------------------------------------------------------------------------- +# 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 style sheet 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 = YES + +# 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 = $(DOXYGEN_MAN_EXTENSION) + +# 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 +# pointed to by INCLUDE_PATH will be searched when 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 that +# overrules the definition found in the source code. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all references to function-like macros +# that are alone on a line, have an all uppercase name, and do not end with a +# semicolon, because these 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. For each +# tag file the location of the external documentation should be added. 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. 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 also works with HAVE_DOT disabled, but it is recommended to +# install and use dot, since it yields more powerful graphs. + +CLASS_DIAGRAMS = YES + +# 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 + +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is +# allowed to run in parallel. When set to 0 (the default) doxygen will +# base this on the number of processors available in the system. You can set it +# explicitly to a value larger than 0 to get control over the balance +# between CPU load and processing speed. + +DOT_NUM_THREADS = 0 + +# By default doxygen will use the Helvetica font for all dot files that +# doxygen generates. When you want a differently looking font you can specify +# the font name using DOT_FONTNAME. You 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 = Helvetica + +# 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 Helvetica font. +# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to +# set the path where dot can find it. + +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 +# 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 the UML_LOOK tag is enabled, the fields and methods are shown inside +# the class node. If there are many fields or methods and many nodes the +# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS +# threshold limits the number of items for each type to make the size more +# managable. Set this to 0 for no limit. Note that the threshold may be +# exceeded by 50% before the limit is enforced. + +UML_LIMIT_NUM_FIELDS = 10 + +# 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 = YES + +# 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 generate a graphical hierarchy of all classes instead of a textual one. + +GRAPHICAL_HIERARCHY = YES + +# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES +# then doxygen will show the dependencies a directory has on other directories +# in a graphical way. The dependency relations are determined by the #include +# relations between the files in the directories. + +DIRECTORY_GRAPH = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are svg, png, jpg, or gif. +# If left blank png will be used. If you choose svg you need to set +# HTML_FILE_EXTENSION to xhtml in order to make the SVG files +# visible in IE 9+ (other browsers do not have this requirement). + +DOT_IMAGE_FORMAT = png + +# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to +# enable generation of interactive SVG images that allow zooming and panning. +# Note that this requires a modern browser other than Internet Explorer. +# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you +# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files +# visible. Older versions of IE do not have SVG support. + +INTERACTIVE_SVG = NO + +# 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 MSCFILE_DIRS tag can be used to specify one or more directories that +# contain msc files that are included in the documentation (see the +# \mscfile command). + +MSCFILE_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 = YES + +# 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/libowlps-client/libowlps-client.c b/libowlps-client/libowlps-client.c index 228b8fd..0c0ef81 100644 --- a/libowlps-client/libowlps-client.c +++ b/libowlps-client/libowlps-client.c @@ -27,12 +27,18 @@ -/* - * Opens an UDP socket to the server whose IP address is 'dest_ip' - * and which listens 'dest_port'. The server information is stored - * into 'server'. The socket will send through the network interface - * 'iface' if specified (if you want the interface to be selected, - * automatically, this parameter should be NULL or an empty string). +/** + * Opens a transmission UDP socket to a server in a simplified way. + * This function uses `owl_create_udp_trx_socket()` (from libowlps) + * as a backend, and allows to select a particular network interface. + * + * @param[in] dest_ip IP address of the remote server. + * @param[in] dest_port Port on which the remote server listens. + * @param[out] server Structure in which the server information will + * be saved. + * @param[in] iface The name of the network interface to send through. + * If this parameter is `NULL` or an empty string, the interface will + * be selected automatically. */ int owl_create_trx_socket(const char *const dest_ip, const uint_fast16_t dest_port, @@ -59,7 +65,10 @@ int owl_create_trx_socket(const char *const dest_ip, -/* Selects 'iface' as sending interface for the socket 'sockfd'. */ +/** + * Selects the interface named `iface` as a transmission interface for + * the socket `sockfd`. + */ void owl_use_iface(const int sockfd, const char *const iface) { #if defined(linux) && defined(__GLIBC__) @@ -80,12 +89,20 @@ void owl_use_iface(const int sockfd, const char *const iface) -/* +/** * Transmits a request. - * No packet will be transmitted if the variable owl_run is (or - * becomes) false. - * nb_pkt: number of packets to transmit. - * delay: delay between two transmissions, in milliseconds. + * No packet will be transmitted if the global variable `owl_run` is + * `false`, and the transmission will stop as soon as possible if it + * becomes `false`. + * + * @param[in] sockfd The file descriptor of the socket to use for the + * transmission. + * @param[in] server The server's information (as generated by + * `owl_create_trx_socket()`, for example). + * @param[in] packet The buffer to send through the socket. + * @param[in] packet_size The buffer's size. + * @param[in] nb_pkt Number of packets to transmit. + * @param[in] delay Delay between two transmissions, in milliseconds. */ void owl_send_request(const int sockfd, const struct sockaddr_in *const server, @@ -125,6 +142,11 @@ void owl_send_request(const int sockfd, +/** + * Transmits a single packet of a request. + * See the documentation of the `owl_send_request()` function for an + * explanation on the parameters. + */ void owl_send_packet(const int sockfd, const struct sockaddr_in *const server, const void *const packet, diff --git a/libowlps-client/owlps-client.h b/libowlps-client/owlps-client.h index 5a0b8c9..01dbd53 100644 --- a/libowlps-client/owlps-client.h +++ b/libowlps-client/owlps-client.h @@ -9,12 +9,14 @@ * contained in the COPYRIGHT.t2t file; the COPYRIGHT.t2t file must be * distributed along with this file, either separately or by replacing * this notice by the COPYRIGHT.t2t file's contents. + */ + +/** + * @file owlps-client.h + * @brief OwlPS Client library * - *********************************************************************** - * - * This is the header file of libowlps-client, the library that contains - * the code used to send positioning requests (normal, calibration and - * autocalibration). + * libowlps-client is the library that contains used to send positioning + * requests (normal, calibration and autocalibration). */ @@ -25,11 +27,14 @@ /* Function headers */ +/// Opens a transmission socket int owl_create_trx_socket(const char *const dest_ip, const uint_fast16_t dest_port, struct sockaddr_in *const server, const char *const iface) ; +/// Selects a transmission interface for the socket `sockfd` void owl_use_iface(const int sockfd, const char *const iface) ; +/// Transmits a request void owl_send_request(const int sockfd, const struct sockaddr_in *const server, const void *const packet, diff --git a/libowlps-resultreader/libowlps-resultreader.c b/libowlps-resultreader/libowlps-resultreader.c index 40d8823..d83fb10 100644 --- a/libowlps-resultreader/libowlps-resultreader.c +++ b/libowlps-resultreader/libowlps-resultreader.c @@ -31,16 +31,19 @@ #define CSV_DELIMITER ";" -/* - * Receives a result from the socket of file descriptor 'sockfd', fills - * an owl_result structure with the received information, and returns a +/** + * Receives a result from the socket of file descriptor `sockfd`, fills + * an `owl_result` structure with the received information, and returns a * pointer to it. * - * Note that the new owl_result is allocated with malloc() and must be - * deleted using free(). + * Note that the new owl_result is allocated with `malloc()` and must be + * deleted using `free()`. * - * In case of error, a message is printed, except if owl_run (from - * libowlps) is false, and NULL is returned. + * In case of error, a message is printed, except if `owl_run` (from + * `owlps.h`) is `false`, and `NULL` is returned. + * + * @returns A pointer to a new `owl_result`. + * @returns `NULL` in case of error. */ owl_result* owl_receive_position(int sockfd) { @@ -61,19 +64,26 @@ owl_result* owl_receive_position(int sockfd) } -/* - * Splits the 'csv' string received from OwlPS Positioner and stores - * the fields in a new owl_result, and returns a pointer to it (or NULL - * in case of error). +/** + * Splits the `csv` string received from OwlPS Positioner and stores + * the fields in a new `owl_result`, and returns a pointer to it (or + * `NULL` in case of error). * - * Note that the new owl_result is allocated with malloc() and must be - * deleted using free(). + * Note that the new `owl_result` is allocated with `malloc()` and must + * be deleted using `free()`. * * Handled CSV format: - * Mobile_MAC;Request_type;Request_timestamp;Algorithm;X;Y;Z;Error;Area + * + * Mobile_MAC;Request_type;Request_timestamp;Algorithm;X;Y;Z;Error;Area + * * The Request_timestamp format is: - * seconds.nanoseconds - * The Area field can be empty. + * + * seconds.nanoseconds + * + * The *Area* field can be empty. + * + * @returns A pointer to a new `owl_result`. + * @returns `NULL` in case of error. */ owl_result* owl_fill_result(char *csv) { @@ -158,17 +168,22 @@ owl_result* owl_fill_result(char *csv) } -/* - * Splits the 'csv' string, stores the fields in a new - * owl_algorithm_result, and returns a pointer to it (or NULL +/** + * Splits the `csv` string, stores the fields in a new + * `owl_algorithm_result`, and returns a pointer to it (or `NULL` * in case of error). * - * Note that the new owl_algorithm_result is allocated with malloc() - * and must be deleted using free(). + * Note that the new owl_algorithm_result is allocated with `malloc()` + * and must be deleted using `free()`. * - * 'csv' must follow this CSV format: - * Algorithm;X;Y;Z;Error;Area - * The Area field can be empty. + * Handled CSV format: + * + * Algorithm;X;Y;Z;Error;Area + * + * The *Area* field can be empty. + * + * @returns A pointer to a new `owl_algorithm_result`. + * @returns `NULL` in case of error. */ owl_algorithm_result* owl_fill_algorithm_result(char **csv) { @@ -247,15 +262,18 @@ owl_algorithm_result* owl_fill_algorithm_result(char **csv) } -/* - * Converts an owl_result back to a CSV string. - * 'dst' must be an allocated string of at least OWL_CSV_RESULT_STRLEN +/** + * Converts an `owl_result back` to a CSV string. + * `dst` must be an allocated string of at least `OWL_CSV_RESULT_STRLEN` * characters. * * CSV format: - * Mobile_MAC;Request_type;Request_timestamp;Nb_algo;Algo_1;…;Algo_n - * Nb_algo is the number of algorithms in the result. - * The format of Algo_i is documented in owl_algorithm_result_to_csv(). + * + * Mobile_MAC;Request_type;Request_timestamp;Nb_algo;Algo_1;…;Algo_n + * + * *Nb_algo* is the number of algorithms in the result. + * The format of *Algo_i* is documented in the documentation of the + * `owl_algorithm_result_to_csv()` function. */ void owl_result_to_csv(char dst[OWL_CSV_RESULT_STRLEN], const owl_result *const src) @@ -287,17 +305,19 @@ void owl_result_to_csv(char dst[OWL_CSV_RESULT_STRLEN], } -/* - * Converts an owl_algorithm_result back to a CSV string. - * 'dst' must be an allocated string of at least - * OWL_CSV_ALGORITHM_RESULT_STRLEN characters. +/** + * Converts an `owl_algorithm_result` back to a CSV string. + * `dst` must be an allocated string of at least + * `OWL_CSV_ALGORITHM_RESULT_STRLEN` characters. * * CSV format: - * Algorithm_name;X;Y;Z;Error;Area_name - * Error is the distance from the true coordinates of the mobile, if - * known; if unknown, Error is set to -1. - * Area_name is the name of the area or room in which the mobile is (may - * be empty). + * + * Algorithm_name;X;Y;Z;Error;Area_name + * + * *Error* is the distance from the true coordinates of the mobile, if + * known; if unknown, *Error* is set to -1. + * *Area_name* is the name of the area or room in which the mobile is + * (may be empty). */ void owl_algorithm_result_to_csv(char dst[OWL_CSV_ALGORITHM_RESULT_STRLEN], @@ -316,17 +336,20 @@ owl_algorithm_result_to_csv(char dst[OWL_CSV_ALGORITHM_RESULT_STRLEN], } -/* - * Converts an owl_result back to a CSV string, in a simplified format. - * Only the *first* algorithm in the result's algorithm list will be +/** + * Converts an `owl_result` back to a CSV string, in a simplified format: + * only the *first* algorithm in the result's algorithm list will be * included in the string. - * 'dst' must be an allocated string of at least - * OWL_CSV_RESULT_SIMPLE_STRLEN characters. + * `dst` must be an allocated string of at least + * `OWL_CSV_RESULT_SIMPLE_STRLEN` characters. * * CSV format: - * Mobile_MAC;First_algorithm - * First_algorithm is the first algorithm in src->results. Its format - * is documented in owl_algorithm_result_to_csv_simple(). + * + * Mobile_MAC;First_algorithm + * + * *First_algorithm* is the first algorithm in `src->results`. Its format + * is documented in the documentation of the + * `owl_algorithm_result_to_csv_simple()` function. */ void owl_result_to_csv_simple(char dst[OWL_CSV_RESULT_SIMPLE_STRLEN], const owl_result *const src) @@ -349,16 +372,18 @@ void owl_result_to_csv_simple(char dst[OWL_CSV_RESULT_SIMPLE_STRLEN], } -/* - * Converts an owl_algorithm_result back to a CSV string, in a +/** + * Converts an `owl_algorithm_result` back to a CSV string, in a * simplified format. - * 'dst' must be an allocated string of at least - * OWL_CSV_ALGORITHM_RESULT_SIMPLE_STRLEN characters. + * `dst` must be an allocated string of at least + * `OWL_CSV_ALGORITHM_RESULT_SIMPLE_STRLEN` characters. * * CSV format: - * X;Y;Z;Area_name - * Area_name is the name of the area or room in which the mobile is (may - * be empty). + * + * X;Y;Z;Area_name + * + * *Area_name* is the name of the area or room in which the mobile is + * (may be empty). */ void owl_algorithm_result_to_csv_simple (char dst[OWL_CSV_ALGORITHM_RESULT_SIMPLE_STRLEN], @@ -375,8 +400,9 @@ void owl_algorithm_result_to_csv_simple } -/* - * Prints an owl_result to the given stream. +/** + * Prints an `owl_result` to the given stream, using `fprintf()`. + * `src` must not be `NULL`. */ void owl_fprint_result(FILE *stream, const owl_result *const src) { @@ -405,8 +431,10 @@ void owl_fprint_result(FILE *stream, const owl_result *const src) } -/* - * Prints an owl_algorithm_result to the given stream. +/** + * Prints an `owl_algorithm_result` to the given stream, using + * `fprintf()`. + * `src` must not be `NULL`. */ void owl_fprint_algorithm_result(FILE *stream, const owl_algorithm_result *const src) @@ -432,11 +460,11 @@ void owl_fprint_algorithm_result(FILE *stream, -/* - * Frees the memory allocated by an owl_result. The 'results' and - * 'mobile_mac_addr' fields *must* be defined, either to NULL or to a - * valid memory block allocated with malloc(). - * Note that the pointer will not set to NULL. +/** + * Frees the memory allocated for an `owl_result`. The `results` and + * `mobile_mac_addr` fields of `result` *must* be defined, either to + * `NULL` or to a valid memory block allocated with `malloc()`. + * Note that `result` will not set to `NULL`. */ void owl_free_result(owl_result *result) { @@ -453,11 +481,12 @@ void owl_free_result(owl_result *result) } -/* - * Frees the memory allocated by a single owl_algorithm_result (*not* - * recursively). The 'algorithm' and 'area' fields *must* be defined, - * either to NULL or to a valid memory block allocated with malloc(). - * Note that the pointer will not set to NULL. +/** + * Frees the memory allocated for a single `owl_algorithm_result` (*not* + * recursively). The `algorithm` and `area` fields of `algo` *must* be + * defined, either to `NULL` or to a valid memory block allocated with + * `malloc()`. + * Note that `algo` will not set to `NULL`. */ void owl_free_algorithm_result(owl_algorithm_result *algo) { diff --git a/libowlps-resultreader/owlps-resultreader-udp.c b/libowlps-resultreader/owlps-resultreader-udp.c index 5239f6c..7ec9cfb 100644 --- a/libowlps-resultreader/owlps-resultreader-udp.c +++ b/libowlps-resultreader/owlps-resultreader-udp.c @@ -16,12 +16,13 @@ * program demonstrating the use of libowlps-resultreader-udp. * The received results are printed on the standard output. * - * This program must be linked against libowlps and its dependencies - * (see the Makefile). + * This program must be linked against libowlps-resultreader and + * libowlps. */ #include "owlps-resultreader.h" +#include #include #include diff --git a/libowlps-resultreader/owlps-resultreader.h b/libowlps-resultreader/owlps-resultreader.h index e536b75..6f0c1cc 100644 --- a/libowlps-resultreader/owlps-resultreader.h +++ b/libowlps-resultreader/owlps-resultreader.h @@ -9,13 +9,17 @@ * contained in the COPYRIGHT.t2t file; the COPYRIGHT.t2t file must be * distributed along with this file, either separately or by replacing * this notice by the COPYRIGHT.t2t file's contents. + */ + +/** + * @file owlps-resultreader.h + * @brief OwlPS Result Reader library * - *********************************************************************** + * libowlps-resultreader is the the library that provides functions to + * read and display results sent on UDP by OwlPS Positioner. * - * This is the header file of libowlps-resultreader, the library that - * provides functions to read results sent on UDP by OwlPS Positioner. - * - * See also the example program owlps-resultreader-udp.c. + * See also the source code of the example program + * `owlps-resultreader-udp`. */ @@ -43,6 +47,7 @@ #define OWL_CSV_ALGORITHM_RESULT_STRLEN \ (OWL_ALGORITHM_STRLEN + 4 * OWL_COORDINATE_STRLEN + \ OWL_AREA_STRLEN + 1) +/// Maximum size of a result CSV string sent by OwlPS Positioner #define OWL_CSV_RESULT_STRLEN \ (OWL_CSV_RESULT_REQUEST_STRLEN + \ OWL_NB_ALGORITHMS * OWL_CSV_ALGORITHM_RESULT_STRLEN + 1) @@ -56,64 +61,90 @@ #define OWL_CSV_RESULT_REQUEST_SIMPLE_STRLEN OWL_ETHER_ADDR_STRLEN #define OWL_CSV_ALGORITHM_RESULT_SIMPLE_STRLEN \ (3 * OWL_COORDINATE_STRLEN + OWL_AREA_STRLEN + 1) +/// Maximum size of a simplified result CSV string as created by +/// *_to_csv_simple() #define OWL_CSV_RESULT_SIMPLE_STRLEN \ (OWL_CSV_RESULT_REQUEST_SIMPLE_STRLEN + \ OWL_NB_ALGORITHMS * OWL_CSV_ALGORITHM_RESULT_SIMPLE_STRLEN + 1) -/* Linked list of algorithms' results. - * Each structure is the result of a single algorithm. +/// Structure of linked list of algorithm's results +/** + * This structure represents the result of a single algorithm, and + * includes a field `next` which points to the next algorithm's result, + * if any, or `NULL` if it is the last algorithm. */ -typedef struct _owl_algorithm_result +struct _owl_algorithm_result { - char *algorithm ; - float x ; - float y ; - float z ; - float error ; - char *area ; + char *algorithm ; ///< Name of the algorithm used to compute the result + float x ; ///< Computed X coordinate + float y ; ///< Computed Y coordinate + float z ; ///< Computed Z coordinate + float error ; ///< Distance error (if available) + char *area ; ///< Name of the area in which the result point is - struct _owl_algorithm_result *next ; -} owl_algorithm_result ; + struct _owl_algorithm_result *next ; ///< Next result +} ; +/// Linked list of algorithms' results +typedef struct _owl_algorithm_result owl_algorithm_result ; -/* Results for a request. Includes the request's data, and the - * list of algorithms' results. +/// Structure of the generated results for a request +/** + * This structure stores the information of a request along with a + * pointer to the list of generated results. */ -typedef struct _owl_result +struct _owl_result { - char *mobile_mac_addr ; - uint8_t request_type ; + char *mobile_mac_addr ; ///< Mobile's MAC address + uint8_t request_type ; ///< Type of the request + /// Local time on the mobile when sending the request owl_timestamp mobile_timestamp ; - unsigned int nb_results ; - owl_algorithm_result *results ; -} owl_result ; + unsigned int nb_results ; ///< Number of results generated + owl_algorithm_result *results ; ///< List of the generated results +} ; +/// Generated results for a request +typedef struct _owl_result owl_result ; +/// Receives a result from the socket `sockfd` owl_result* owl_receive_position(int sockfd) ; +/// Splits the `csv` string and stores it in a new `owl_result` owl_result* owl_fill_result(char *csv) ; +/// Splits the `csv` string and stores it in a new `owl_algorithm_result` owl_algorithm_result* owl_fill_algorithm_result(char **csv) ; +/// Converts an `owl_result back` to a CSV string void owl_result_to_csv(char dst[OWL_CSV_RESULT_STRLEN], const owl_result *const src) ; +/// Converts an `owl_algorithm_result` back to a CSV string void owl_algorithm_result_to_csv(char dst[OWL_CSV_ALGORITHM_RESULT_STRLEN], const owl_algorithm_result *const src) ; +/// Converts an `owl_result` back to a CSV string (simplified format) void owl_result_to_csv_simple(char dst[OWL_CSV_RESULT_SIMPLE_STRLEN], const owl_result *const src) ; +/// Converts an `owl_algorithm_result` back to a CSV string (simplified +/// format) void owl_algorithm_result_to_csv_simple (char dst[OWL_CSV_ALGORITHM_RESULT_SIMPLE_STRLEN], const owl_algorithm_result *const src) ; +/// Prints an `owl_result` to the given stream void owl_fprint_result(FILE *stream, const owl_result *const src) ; +/// Prints an `owl_algorithm_result` to the given stream void owl_fprint_algorithm_result(FILE *stream, const owl_algorithm_result *const src) ; +/// Prints an `owl_result` to the standard output #define owl_print_result(SRC) \ (owl_fprint_result(stdout, (SRC))) +/// Prints an `owl_algorithm_result` to the standard output #define owl_print_algorithm_result(SRC) \ (owl_fprint_algorithm_result(stdout, (SRC))) +/// Frees an `owl_result` void owl_free_result(owl_result *result) ; +/// Frees a single `owl_algorithm_result` void owl_free_algorithm_result(owl_algorithm_result *algo) ; diff --git a/libowlps/libowlps.c b/libowlps/libowlps.c index 2015610..ced95ff 100644 --- a/libowlps/libowlps.c +++ b/libowlps/libowlps.c @@ -40,11 +40,14 @@ bool owl_run = true ; /* *** Miscellaneous functions *** */ -/* - * Converts a MAC address from bytes to string. +/** + * Converts a MAC address from bytes to character string. * The string is allocated in a static buffer, and will be overwritten * each time this function is called. - * This function is not thread-safe! + * **This function is not thread-safe!** + * + * @returns A pointer to the static buffer containing the character + * string. This pointer must *not* be freed manually by the caller. */ const char* owl_mac_bytes_to_string(const uint8_t *const mac_binary) { @@ -54,9 +57,10 @@ const char* owl_mac_bytes_to_string(const uint8_t *const mac_binary) } -/* - * Converts a MAC address from bytes to string. - * 'mac_str' must be allocated by the caller. +/** + * Converts a MAC address from bytes to character string. + * The `mac_str` buffer must be allocated by the caller and its length + * must be of at least `OWL_ETHER_ADDR_STRLEN`. * This function is thread-safe. */ void owl_mac_bytes_to_string_r(const uint8_t *const mac_binary, @@ -69,9 +73,10 @@ void owl_mac_bytes_to_string_r(const uint8_t *const mac_binary, } -/* +/** * Compares two MAC addresses. - * Returns true if they are identical, false otherwise. + * + * @returns `true` if the two addresses are identical, `false` otherwise. */ bool owl_mac_equals(const uint8_t *const mac1, const uint8_t *const mac2) @@ -84,9 +89,12 @@ bool owl_mac_equals(const uint8_t *const mac1, } -/* - * Converts a IEEE 802.11 frequency into a channel number. - * Returns 0 if the frequency does not correspond to an official channel. +/** + * Converts a IEEE 802.11 frequency (in MHz) into a channel number. + * + * @returns The channel number corresponding to `frequency`. + * @returns 0 if the frequency does not correspond to an official + * channel. */ uint_fast8_t owl_frequency_to_channel(const uint_fast16_t frequency) { @@ -129,12 +137,15 @@ uint_fast8_t owl_frequency_to_channel(const uint_fast16_t frequency) /* *** Time *** */ -/* +/** * Sleeps for a given amount of milliseconds. - * 'time_ms' is an unsigned value, so please be careful: passing a + * `time_ms` is an unsigned value, so please be careful: passing a * negative value may not do what you think. - * In case of error, a message is displayed and a non-zero error code - * is returned (if positive, it is the number of non-sleeped seconds). + * In case of error, a message is displayed on the standard error. + * + * @returns 0 if everything went well. + * @returns A non-zero error code in case of error; if positive, it is + * the number of non-slept seconds. */ int owl_msleep(uint32_t time_ms) { @@ -163,9 +174,10 @@ int owl_msleep(uint32_t time_ms) } -/* - * Sets the owl_timestamp 'now' at the current time. - * Returns 0 in case of success non-zero otherwise. +/** + * Sets the `owl_timestamp` `now` to the current time. + * + * @returns 0 in case of success, non-zero otherwise. */ int owl_timestamp_now(owl_timestamp *const now) { @@ -195,8 +207,9 @@ int owl_timestamp_now(owl_timestamp *const now) } -/* - * Converts the struct timespec 'src' into the owl_timestamp 'dst'. +/** + * Converts the `struct timespec` `src` into the `owl_timestamp` `dst`. + * `src` and `dst` must not be `NULL`. */ void owl_timespec_to_timestamp(const struct timespec *const src, owl_timestamp *const dst) @@ -208,8 +221,9 @@ void owl_timespec_to_timestamp(const struct timespec *const src, } -/* - * Converts the struct timeval 'src' into the owl_timestamp 'dst'. +/** + * Converts the `struct timeval` `src` into the `owl_timestamp` `dst`. + * `src` and `dst` must not be `NULL`. */ void owl_timeval_to_timestamp(const struct timeval *const src, owl_timestamp *const dst) @@ -221,6 +235,11 @@ void owl_timeval_to_timestamp(const struct timeval *const src, } +/** + * Compares two `owl_timestamp` and returns `true` if they are equal, + * `false` otherwise. + * `d1` and `d2` must not be `NULL`. + */ bool owl_timestamp_equals(const owl_timestamp *const d1, const owl_timestamp *const d2) { @@ -230,8 +249,11 @@ bool owl_timestamp_equals(const owl_timestamp *const d1, } -/* - * Converts a owl_timestamp date value into milliseconds. +/** + * Converts the `owl_timestamp` date value `d` into milliseconds. + * `d` must not be `NULL`. + * + * @returns The millisecond value of `d`. */ uint64_t owl_timestamp_to_ms(const owl_timestamp *const d) { @@ -241,9 +263,10 @@ uint64_t owl_timestamp_to_ms(const owl_timestamp *const d) } -/* - * Converts a owl_timestamp date value into a printable string. - * 'dst' must be an allocated array of at least OWL_TIMESTAMP_STRLEN +/** + * Converts the `owl_timestamp` date value `src` into a printable string. + * `src` must not be `NULL`. + * `dst` must be an allocated array of at least `OWL_TIMESTAMP_STRLEN` * characters. */ void owl_timestamp_to_string(const owl_timestamp *const src, @@ -256,8 +279,12 @@ void owl_timestamp_to_string(const owl_timestamp *const src, } -/* - * Returns the time (in milliseconds) between two dates. +/** + * Returns the time (in milliseconds) elapsed between two `owl_timestamp` + * `d1` and `d2`. `d1` can either be lower (before) or greater (after) + * `d2`, the returned value will always be the delay between the older + * and the newer time. + * `d1` and `d2` must not be NULL. */ uint_fast32_t owl_time_elapsed_ms(const owl_timestamp *const d1, const owl_timestamp *const d2) @@ -268,12 +295,12 @@ uint_fast32_t owl_time_elapsed_ms(const owl_timestamp *const d1, } -/* - * Computes the time difference between two owl_timestamp 'd1' and - * 'd2'. +/** + * Computes the time difference between two `owl_timestamp` `d1` and + * `d2`. The result is stored in the `elapsed` parameter. * Note that it is a delay, not a simple substraction, therefore the - * result is always positive. The result is stored in the 'elapsed' - * argument. + * result is always positive. + * NULL parameters are not accepted. */ void owl_time_elapsed(const owl_timestamp *const d1, const owl_timestamp *const d2, @@ -323,11 +350,13 @@ void owl_time_elapsed(const owl_timestamp *const d1, -/* *** Endianess *** */ +/* *** Endianness *** */ -/* - * Converts a owl_timestamp from host endianness to network endianness. +/** + * Converts an `owl_timestamp` from host endianness to network + * endianness. + * The conversion is done in-place. `d` must not be `NULL`. */ void owl_hton_timestamp(owl_timestamp *const d) { @@ -337,8 +366,10 @@ void owl_hton_timestamp(owl_timestamp *const d) } -/* - * Converts a owl_timestamp from network endianness to host endianness. +/** + * Converts an `owl_timestamp` from network endianness to host + * endianness. + * The conversion is done in-place. `d` must not be `NULL`. */ void owl_ntoh_timestamp(owl_timestamp *const d) { @@ -348,10 +379,13 @@ void owl_ntoh_timestamp(owl_timestamp *const d) } -/* - * Swap bytes composing a float. - * You probably want to use the macros owl_htonf() and owl_ntohf() +/** + * This function swaps the bytes composing a `float`, i.e. it changes + * their order. + * You probably want to use the `owl_htonf()` and `owl_ntohf()` macros * instead of this function. + * + * @returns The swapped `float`. */ float owl_swap_float(const float f) { @@ -375,16 +409,18 @@ float owl_swap_float(const float f) /* *** Network *** */ -/* - * Creates a UDP transmission socket and returns its descriptor. - * Parameters: - * - server_address: the server IP address. - * - server_port: the listening port on the server. - * - server_description (in/out): the structure in which the server - * description will be saved. - * - client_description (in/out): the structure in which the client - * description will be saved. - * Returns a negative error code in case of error. +/** + * Opens a UDP transmission socket and returns its descriptor. + * + * @param[in] server_address The server's IP address. + * @param[in] server_port The listening port on the server. + * @param[out] server_description The structure in which the server + * description will be saved. + * @param[out] client_description The structure in which the client + * description will be saved. + * + * @returns A file descriptor to the opened socket in case of success, + * or a negative error code. */ int owl_create_udp_trx_socket(const char *const server_address, const uint_fast16_t server_port, @@ -418,11 +454,12 @@ int owl_create_udp_trx_socket(const char *const server_address, } -/* - * Creates a UDP reception socket and returns its descriptor. - * Parameters: - * - port: port on which the socket listens. - * Returns a negative error code in case of error. +/** + * Opens a UDP reception socket and returns its descriptor. + * `port` is the port on which the socket will listen. + * + * @returns A file descriptor to the opened socket in case of success, + * or a negative error code. */ int owl_create_udp_listening_socket(const uint_fast16_t port) { @@ -463,8 +500,11 @@ int owl_create_udp_listening_socket(const uint_fast16_t port) /* *** Signals *** */ -/* +/** * Generic signal handler for SIGINT. + * + * @param num The catched signal. This function will exit with + * `OWL_ERR_BAD_SIGNAL` if `num != SIGINT`. */ void owl_sigint_handler(const int num) { @@ -484,8 +524,11 @@ void owl_sigint_handler(const int num) } -/* +/** * Generic signal handler for SIGTERM. + * + * @param num The catched signal. This function will exit with + * `OWL_ERR_BAD_SIGNAL` if `num != SIGTERM`. */ void owl_sigterm_handler(const int num) { @@ -504,9 +547,11 @@ void owl_sigterm_handler(const int num) /* *** Thread-related functions *** */ -/* - * Closes the file descriptor 'fd'. - * 'fd' must be passed as an int pointer (int*). +/** + * Closes the file descriptor `fd`. + * `fd` must be passed as an int pointer (`int*`). If `fd` is `NULL`, + * nothing will be done. Uppon error, a message is displayed on the + * standard error. */ void owl_close_fd(void *const fd) { @@ -524,10 +569,11 @@ void owl_close_fd(void *const fd) } -/* - * Closes the stream 'file'. - * 'file' must be passed as a pointer on a pointer of FILE (FILE**). - * If *file either stdout, stderr or stdin, it will not be closed. +/** + * Closes the stream `file`. + * `file` must be passed as a pointer on a pointer of FILE (FILE**). + * If `*file` is either `stdout`, `stderr` or `stdin`, it will not be + * closed. */ void owl_close_file(void *const file) { diff --git a/libowlps/owlps.h b/libowlps/owlps.h index 10daa2d..9758440 100644 --- a/libowlps/owlps.h +++ b/libowlps/owlps.h @@ -9,23 +9,31 @@ * contained in the COPYRIGHT.t2t file; the COPYRIGHT.t2t file must be * distributed along with this file, either separately or by replacing * this notice by the COPYRIGHT.t2t file's contents. + */ + +/** + * @file owlps.h + * @brief OwlPS library * - *********************************************************************** - * - * This is the header file of libowlps, the library containing the code - * shared by most of the OwlPS programs. + * libowlps is the library containing the code shared by most of the + * OwlPS programs. */ #ifndef _LIBOWLPS_H_ #define _LIBOWLPS_H_ +#ifdef __cplusplus +# include +#else // __cplusplus +# include +#endif // __cplusplus + #ifdef __cplusplus extern "C" { #endif // __cplusplus -#include // We'll use with C++ 0x #include #include #include @@ -34,114 +42,180 @@ extern "C" { #include -// Port on which the positioning and calibration requests are sent by -// the mobiles (or the listeners for autocalibration requests): +/** @name Network ports */ +//@{ +/// Port on which the positioning and calibration requests are sent by +/// the mobiles (or the listeners for autocalibration requests) #define OWL_DEFAULT_REQUEST_PORT 9900 -// Port on which listeners and aggregator communicate: +/// Port on which listeners and aggregator communicate #define OWL_DEFAULT_LISTENER_PORT 9901 -// Port on which Aggregator and Positioner communicate: +/// Port on which Aggregator and Positioner communicate #define OWL_DEFAULT_AGGREGATION_PORT 9902 -// Port on which the aggregator listens for hello messages from the -// listeners: +/// Port on which the aggregator listens for hello messages from the +/// listeners #define OWL_DEFAULT_AUTOCALIBRATION_HELLO_PORT 9903 -// Port on which the listeners listen for orders from the aggregator: +/// Port on which the listeners listen for orders from the aggregator #define OWL_DEFAULT_AUTOCALIBRATION_ORDER_PORT 9904 -// Port on which the mobile listens for its position: +/// Port on which the mobile listens for its position #define OWL_DEFAULT_RESULT_PORT 9910 +//@} -/* Direction type */ -enum {owl_north = 1, owl_east, owl_south, owl_west} ; +/// Directions +enum owl_directions +{ + owl_north = 1, ///< North direction + owl_east, ///< East direction + owl_south, ///< South direction + owl_west ///< West direction +} ; +/// First [direction](@ref owl_direction) #define OWL_DIRECTION_MIN 1 +/// Last [direction](@ref owl_direction) #define OWL_DIRECTION_MAX 4 +/// Direction type typedef uint8_t owl_direction ; -/* Timestamp type (struct timespec clone with fixed size fields) */ -typedef struct _owl_timestamp +/// Timestamp structure +/** + * This timestamp structure is a clone of `struct timespec` (from + * `time.h`), but with fixed-size fields. + */ +struct _owl_timestamp { - uint32_t tv_sec ; - uint32_t tv_nsec ; -} owl_timestamp ; -// Length of a owl_timestamp when converted to string: -#define OWL_TIMESTAMP_STRLEN 22 // 22 = 10 digits, '.', 10 digits, '\0' + uint32_t tv_sec ; ///< Seconds + uint32_t tv_nsec ; ///< Nanoseconds +} ; +/// Timestamp type +typedef struct _owl_timestamp owl_timestamp ; + +/** @name String lengths */ +//@{ +/// Length of a owl_timestamp when converted to string +/** + * 22 = 10 digits, '.', 10 digits, '\0' + */ +#define OWL_TIMESTAMP_STRLEN 22 +//@} -/* Message sent by the listener to the aggregator */ -typedef struct _owl_captured_request +/// Message sent by the Listener to the Aggregator +/** + * Message sent by the Listener to the Aggregator for each captured + * request. + */ +struct _owl_captured_request { - uint8_t type ; // Type of the captured request - uint16_t nb_packets ; // Number of packets for this request - uint16_t packet_id ; // Number of the current packet - uint8_t ap_mac_addr_bytes[ETHER_ADDR_LEN] ; // MAC of the listener - uint8_t mobile_mac_addr_bytes[ETHER_ADDR_LEN] ; // MAC of the mobile - uint8_t mobile_ip_addr_bytes[4] ; // IP of the mobile - owl_timestamp request_time ; // Timestamp on the mobile - owl_timestamp capture_time ; // Timestamp of arrival on the listener - int8_t ss_dbm ; // Signal strength measured by the listener (dBm) + uint8_t type ; ///< Type of the captured request + uint16_t nb_packets ; ///< Number of packets for this request + uint16_t packet_id ; ///< Number of the current packet + uint8_t ap_mac_addr_bytes[ETHER_ADDR_LEN] ; ///< MAC of the listener + uint8_t mobile_mac_addr_bytes[ETHER_ADDR_LEN] ; ///< MAC of the mobile + uint8_t mobile_ip_addr_bytes[4] ; ///< IP of the mobile + owl_timestamp request_time ; ///< Timestamp on the mobile + owl_timestamp capture_time ; ///< Timestamp of arrival on the listener + int8_t ss_dbm ; ///< Signal strength measured by the listener (dBm) /* Calibration data */ - float x_position ; - float y_position ; - float z_position ; - owl_direction direction ; -} owl_captured_request ; + float x_position ; ///< X coordinate + float y_position ; ///< Y coordinate + float z_position ; ///< Z coordinate + owl_direction direction ; ///< Orientation of the mobile +} ; +/// Captured request type +typedef struct _owl_captured_request owl_captured_request ; -/* Message sent by the Aggregator to the Positioner containing - * the main data of a request */ -typedef struct _owl_request +/// Message sent by the Aggregator to the Positioner (request's data) +/** + * Message sent by the Aggregator to the Positioner containing + * the main data of a request. + */ +struct _owl_request { - uint8_t type ; // Type of the request - uint16_t nb_packets ; // Number of packets sent for this request - uint8_t mobile_mac_addr_bytes[ETHER_ADDR_LEN] ; // MAC of the mobile - uint8_t mobile_ip_addr_bytes[4] ; // IP of the mobile - owl_timestamp request_time ; // Timestamp on the mobile - uint16_t nb_info ; // Number of owl_request_info + uint8_t type ; ///< Type of the request + uint16_t nb_packets ; ///< Number of packets sent for this request + uint8_t mobile_mac_addr_bytes[ETHER_ADDR_LEN] ; ///< MAC of the mobile + uint8_t mobile_ip_addr_bytes[4] ; ///< IP of the mobile + owl_timestamp request_time ; ///< Timestamp on the mobile + uint16_t nb_info ; ///< Number of owl_request_info /* Calibration data */ - float x_position ; - float y_position ; - float z_position ; - owl_direction direction ; -} owl_request ; + float x_position ; ///< X coordinate + float y_position ; ///< Y coordinate + float z_position ; ///< Z coordinate + owl_direction direction ; ///< Orientation of the mobile +} ; +/// Aggregated request type +typedef struct _owl_request owl_request ; -/* Message sent by the Aggregator to the Positioner refering to +/// Message sent by the Aggregator to the Positioner (signal strength) +/** + * Message sent by the Aggregator to the Positioner refering to * a request, indicating that an AP received the request with a given - * signal strength */ -typedef struct _owl_request_info + * signal strength. + */ +struct _owl_request_info { - uint16_t packet_id ; // Number of the current packet - uint8_t ap_mac_addr_bytes[ETHER_ADDR_LEN] ; // MAC of the listener - owl_timestamp capture_time ; // Timestamp of arrival on the listener - int8_t ss_dbm ; // Signal strength measured by the listener (dBm) -} owl_request_info ; + uint16_t packet_id ; ///< Number of the current packet + uint8_t ap_mac_addr_bytes[ETHER_ADDR_LEN] ; ///< MAC of the listener + owl_timestamp capture_time ; ///< Timestamp of arrival on the listener + int8_t ss_dbm ; ///< Signal strength measured by the listener (dBm) +} ; +/// Aggregated request information type +typedef struct _owl_request_info owl_request_info ; -/* Hello message sent by the listener to the aggregator */ -typedef struct _owl_autocalibration_hello +/// *Hello* message sent by the Listener to the Aggregator +/** + * This structure represents a *hello* message sent to the Aggregator by + * each Listener to signal its presence. + */ +struct _owl_autocalibration_hello { + /// MAC address of the Listener uint8_t ap_mac_addr_bytes[ETHER_ADDR_LEN] ; -} owl_autocalibration_hello ; +} ; +/// *Hello* message type +typedef struct _owl_autocalibration_hello owl_autocalibration_hello ; -/* Message sent to the listener to order an emission */ -#define AUTOCALIBRATION_ORDER_SEND 1 -typedef struct _owl_autocalibration_order +/// Message sent to the Listener to order an emission +/** + * This structure represents a message sent by the Aggregator to a + * Listener to order it to send an autocalibration request. + */ +struct _owl_autocalibration_order { - uint8_t order ; -} owl_autocalibration_order ; + uint8_t order ; ///< Code of the order +} ; +/// Autocalibration order type +typedef struct _owl_autocalibration_order owl_autocalibration_order ; +/** @name Autocalibration order type identifiers */ +//@{ +#define AUTOCALIBRATION_ORDER_SEND 1 +//@} -/* Positioning request types */ +/** @name Request type identifiers */ +//@{ +/// "Normal" positioning request #define OWL_REQUEST_NORMAL 0 +/// Calibration request #define OWL_REQUEST_CALIBRATION 1 +/// Autocalibration request #define OWL_REQUEST_AUTOCALIBRATION 2 +/// Generated request (in Positioner) #define OWL_REQUEST_GENERATED 3 +/// Implicit positioning request #define OWL_REQUEST_IMPLICIT 10 +/// Undefined or unknown request type #define OWL_REQUEST_UNDEFINED 255 +//@} -/* Wi-Fi channel frequencies in MHz */ +/** @name Wi-Fi channels' frequencies in MHz */ +//@{ #define OWL_80211_MHZ_CHANNEL_1 2412 #define OWL_80211_MHZ_CHANNEL_2 2417 #define OWL_80211_MHZ_CHANNEL_3 2422 @@ -156,8 +230,10 @@ typedef struct _owl_autocalibration_order #define OWL_80211_MHZ_CHANNEL_12 2467 #define OWL_80211_MHZ_CHANNEL_13 2472 #define OWL_80211_MHZ_CHANNEL_14 2477 +//@} -/* Wi-Fi channel frequencies in Hz */ +/** @name Wi-Fi channels' frequencies in Hz */ +//@{ #define OWL_80211_HZ_CHANNEL_1 2412000000ul #define OWL_80211_HZ_CHANNEL_2 2417000000ul #define OWL_80211_HZ_CHANNEL_3 2422000000ul @@ -172,87 +248,137 @@ typedef struct _owl_autocalibration_order #define OWL_80211_HZ_CHANNEL_12 2467000000ul #define OWL_80211_HZ_CHANNEL_13 2472000000ul #define OWL_80211_HZ_CHANNEL_14 2477000000ul +//@} -/* Misc. */ -// Length of a MAC address in string format (including '\0') +/** @name String lengths */ +//@{ +/// Length of a MAC address in string format (including '\0') #define OWL_ETHER_ADDR_STRLEN 18 -// Maximum length of an algorithm name (including '\0') +/// Maximum length of an algorithm name (including '\0') #define OWL_ALGORITHM_STRLEN 31 -// Maximum length of an area name (including '\0') +/// Maximum length of an area name (including '\0') #define OWL_AREA_STRLEN 31 -// Maximum length of a coordinate X, Y or Z (including '\0') +/// Maximum length of a coordinate X, Y or Z (including '\0') #define OWL_COORDINATE_STRLEN 16 +//@} /* Global variables */ -// Used to handle end of loops: +/// Global variable used to handle end of loops extern bool owl_run ; -/* Error codes */ -/* User interface */ -// Wrong program invokation (command-line arguments): +/** @name Error codes */ +//@{ +/// Wrong program invokation (command-line arguments) #define OWL_ERR_BAD_USAGE 100 -// Error when reading/parsing the configuration file: +/// Error when reading/parsing the configuration file #define OWL_ERR_CONFIG_FILE 101 /* System */ -// Error when creating a thread: +/// Error when creating a thread #define OWL_ERR_THREAD_CREATE 110 -// Wrong signal received: +/// Wrong signal received #define OWL_ERR_BAD_SIGNAL 111 /* Network communication */ -// Error when creating a socket: +/// Error when creating a socket #define OWL_ERR_SOCKET_CREATE 120 -// Error when sending a message on a socket: +/// Error when sending a message on a socket #define OWL_ERR_SOCKET_SEND 121 -// Error when reading from a socket: +/// Error when reading from a socket #define OWL_ERR_SOCKET_RECV 122 /* Network interface / capture */ -// Error when opening the capture interface: +/// Error when opening the capture interface #define OWL_ERR_IFACE_PCAP_OPEN 130 -// Error when reading the interface Wi-Fi mode: +/// Error when reading the interface Wi-Fi mode #define OWL_ERR_IFACE_MODE_GET 131 -// Error when setting the interface Wi-Fi mode: +/// Error when setting the interface Wi-Fi mode #define OWL_ERR_IFACE_MODE_SET 132 +//@} /* Macros */ -// Converts a bool to the corresponding string +/// Converts a bool to the corresponding string #define OWL_BOOL_TO_STRING(B) ((B) ? "true" : "false") /* Function headers */ -// Misc +/** @name Miscellaneous */ +//@{ +/// Converts a MAC address from bytes to string const char* owl_mac_bytes_to_string(const uint8_t *const mac_binary) ; +/// Converts a MAC address from bytes to string void owl_mac_bytes_to_string_r(const uint8_t *const mac_binary, char mac_str[OWL_ETHER_ADDR_STRLEN]) ; +/// Compares two MAC addresses bool owl_mac_equals(const uint8_t *const mac1, const uint8_t *const mac2) ; +/// Converts a IEEE 802.11 frequency into a channel number uint_fast8_t owl_frequency_to_channel(const uint_fast16_t frequency) ; +//@} -// Time +/** @name Time */ +//@{ +/// Sleeps for a given amount of milliseconds int owl_msleep(uint32_t time_ms) ; +/// Sets the `owl_timestamp` `now` to the current time int owl_timestamp_now(owl_timestamp *const now) ; +/// Converts a `struct timespec` to an `owl_timestamp` void owl_timespec_to_timestamp(const struct timespec *const src, owl_timestamp *const dst) ; +/// Converts a `struct timeval` to an `owl_timestamp` void owl_timeval_to_timestamp(const struct timeval *const src, owl_timestamp *const dst) ; +/// Compares two `owl_timestamp` bool owl_timestamp_equals(const owl_timestamp *const d1, const owl_timestamp *const d2) ; +/// Converts an `owl_timestamp` date value into milliseconds uint64_t owl_timestamp_to_ms(const owl_timestamp *const d) ; +/// Converts an `owl_timestamp` date value into a printable string void owl_timestamp_to_string(const owl_timestamp *const src, char *const dst) ; +/// Returns the time (in milliseconds) between two dates uint_fast32_t owl_time_elapsed_ms(const owl_timestamp *const d1, const owl_timestamp *const d2) ; +/// Computes the time difference between two dates void owl_time_elapsed(const owl_timestamp *const d1, const owl_timestamp *const d2, owl_timestamp *const elapsed) ; +//@} -// Endianess +/** @name Endianness */ +//@{ +/// Changes the endianness of an `owl_timestamp` from host to network +/// order void owl_hton_timestamp(owl_timestamp *const d) ; +/// Changes the endianness of an `owl_timestamp` from network to host +/// order void owl_ntoh_timestamp(owl_timestamp *const d) ; +/// Changes the order of the bytes of a `float` float owl_swap_float(const float f) ; +//@} + +/** @name Endianness-related macros */ +//@{ +/** + * @def owl_htonf + * @brief Changes the endianness of a `float` from host to network + * + * This macro converts the byte order of a `float` if needed, depending + * on the endianness of the host, to adopt the endianness of the network. + * To actually change the byte order, the `owl_swap_float()` function is + * used. + * + * @def owl_ntohf + * @brief Changes the endianness of a `float` from network to host + * + * This macro converts the byte order of a `float` encoded with a network + * endianness to adopt the endianness of the host, if the two endianness + * are different. + * To actually change the byte order, the `owl_swap_float()` function is + * used. + */ +//@} #if __BYTE_ORDER == __BIG_ENDIAN # define owl_htonf(f) (f) # define owl_ntohf(f) (f) @@ -265,20 +391,33 @@ float owl_swap_float(const float f) ; # endif // __BYTE_ORDER == __LITTLE_ENDIAN #endif // __BYTE_ORDER == __BIG_ENDIAN -// Network + +/** @name Network */ +//@{ +/// Opens a UDP transmission socket int owl_create_udp_trx_socket(const char *const server_address, const uint_fast16_t server_port, struct sockaddr_in *const server_description, struct sockaddr_in *const client_description) ; +/// Opens a UDP reception socket int owl_create_udp_listening_socket(const uint_fast16_t port) ; +//@} -// Signals +/** @name Signals */ +//@{ +/// Generic signal handler for SIGINT void owl_sigint_handler(const int num) ; +/// Generic signal handler for SIGTERM void owl_sigterm_handler(const int num) ; +//@} -// Threads +/** @name Threads */ +//@{ +/// Closes the file descriptor `fd` void owl_close_fd(void *const fd) ; +/// Closes the stream `file` void owl_close_file(void *const file) ; +//@} #ifdef __cplusplus