-# Doxyfile 1.8.5
+# Doxyfile 1.8.6
# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project.
# entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used.
-OUTPUT_DIRECTORY = doxy
+OUTPUT_DIRECTORY = $(BUILDDIR)doxy
# 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
# 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.
-# Possible values are: Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-
-# Traditional, Croatian, Czech, Danish, Dutch, English, Esperanto, Farsi,
-# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en,
-# Korean, Korean-en, Latvian, Norwegian, Macedonian, Persian, Polish,
-# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
-# Turkish, Ukrainian and Vietnamese.
+# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
+# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
+# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
+# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
+# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
+# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
+# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
+# Ukrainian and Vietnamese.
# The default value is: English.
OUTPUT_LANGUAGE = English
# will be relative from the directory where doxygen is started.
# This tag requires that the tag FULL_PATH_NAMES is set to YES.
-STRIP_FROM_PATH =
+STRIP_FROM_PATH = . $(BUILDDIR)
# 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
SHOW_INCLUDE_FILES = YES
+# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
+# grouped member an include statement to the documentation, telling the reader
+# which file to include in order to use the member.
+# The default value is: NO.
+
+SHOW_GROUPED_MEMB_INC = 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.
# The default value is: NO.
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
# descriptions of file, namespace and class members alphabetically by member
-# name. If set to NO the members will appear in declaration order.
+# name. If set to NO the members will appear in declaration order. Note that
+# this will also influence the order of the classes in the class list.
# The default value is: NO.
SORT_BRIEF_DOCS = NO
# messages are off.
# The default value is: NO.
-QUIET = NO
+QUIET = YES
# The WARNINGS tag can be used to turn on/off the warning messages that are
# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
# spaces.
# Note: If this tag is empty the current directory is searched.
-INPUT = .
+INPUT = src include $(BUILDDIR)include/libsigrok
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
# Note that relative paths are relative to the directory from which doxygen is
# run.
-EXCLUDE = config.h libsigrok-internal.h session_driver.c std.c
+EXCLUDE = config.h src/libsigrok-internal.h src/session_driver.c
+EXCLUDE += src/std.c src/drivers.c src/ezusb.c src/fallback.c
+EXCLUDE += src/soft-trigger.c src/usb.c
# 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
#
# Ignore the following files and directories (see also EXCLUDE above):
# - config.h: Non-public stuff, the file doesn't get installed.
-# - libsigrok-internal.h: Non-public stuff, the file doesn't get installed.
-# - session_driver.c: Special driver for "virtual" devices, non-public.
-# - std.c: Non-public helpers, no public API stuff in there.
-# - hardware/*: Only driver-specific stuff, no public API stuff in there.
-# - input/*: Only input.c contains public API, everything else doesn't.
-# - output/*: Only output.c contains public API, everything else doesn't.
+# - src/libsigrok-internal.h: Non-public stuff, the file doesn't get installed.
+# - src/session_driver.c: Special driver for "virtual" devices, non-public.
+# - src/std.c: Non-public helpers, no public API stuff in there.
+# - src/drivers.c: Non-public helpers, no public API stuff in there.
+# - src/ezusb.c: Non-public helpers, no public API stuff in there.
+# - src/fallback.c: Fallback functions to API calls from serial.c.
+# - src/soft-trigger.c: Non-public helpers, no public API stuff in there.
+# - src/usb.c: Non-public helpers, no public API stuff in there.
+# - src/hardware/*: Only driver-specific stuff, no public API stuff in there.
+# - src/input/*: Only input.c contains public API, everything else doesn't.
+# - src/output/*: Only output.c contains public API, everything else doesn't.
+# - src/transform/*: Only transform.c contains public API, everything else doesn't.
+# - src/scpi/*: Non-public helpers, no public API stuff in there.
+# - src/dmm/*: Non-public helpers, no public API stuff in there.
+# - src/lcr/*: Non-public helpers, no public API stuff in there.
# - tests/*: Unit tests, no public API stuff in there.
# - bindings/*: Language bindings, no public API stuff in there.
+# - doxy/*: Potentially already generated docs, should not be scanned.
#
-EXCLUDE_PATTERNS = */hardware/* */input/* */output/* */tests/*
-EXCLUDE_PATTERNS += */bindings/*
-INPUT += input/input.c output/output.c
+EXCLUDE_PATTERNS = */src/hardware/* */src/input/* */src/output/* */src/transform/*
+EXCLUDE_PATTERNS += */src/scpi/* */src/dmm/* */src/lcr/*
+EXCLUDE_PATTERNS += */src/tests/* */src/bindings/* */src/doxy/*
+INPUT += src/input/input.c src/output/output.c
+INPUT += src/transform/transform.c
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the
# captures the structure of the code including all documentation.
# The default value is: NO.
-GENERATE_XML = NO
+GENERATE_XML = YES
# 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
# The default value is: YES.
# This tag requires that the tag GENERATE_XML is set to YES.
-XML_PROGRAMLISTING = YES
+XML_PROGRAMLISTING = NO
#---------------------------------------------------------------------------
# Configuration options related to the DOCBOOK output
MSCGEN_PATH =
+# You can include diagrams made with dia in doxygen documentation. Doxygen will
+# then run dia to produce the diagram and insert it in the documentation. The
+# DIA_PATH tag allows you to specify the directory where the dia binary resides.
+# If left empty dia is assumed to be found in the default search path.
+
+DIA_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.
# The default value is: YES.
MSCFILE_DIRS =
+# The DIAFILE_DIRS tag can be used to specify one or more directories that
+# contain dia files that are included in the documentation (see the \diafile
+# command).
+
+DIAFILE_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
projects / libsigrok.git / blobdiff