X-Git-Url: https://sigrok.org/gitweb/?p=libsigrok.git;a=blobdiff_plain;f=Doxyfile;h=4665f424b515508e2ad207f3010a9a5de800d427;hp=2bd7df5dba989db33cc92a079c669aebb41d179c;hb=e4204b1757459a03c0a70849a659f27387edc295;hpb=3532ed01256b986ecaf37ea5bb29d81465e2aa89 diff --git a/Doxyfile b/Doxyfile index 2bd7df5d..4665f424 100644 --- a/Doxyfile +++ b/Doxyfile @@ -38,7 +38,7 @@ PROJECT_NAME = "libsigrok" # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = "unreleased development snapshot" +PROJECT_NUMBER = "0.5.1" # 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 @@ -51,14 +51,14 @@ PROJECT_BRIEF = "sigrok hardware access and backend library" # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo # to the output directory. -PROJECT_LOGO = contrib/sigrok-logo-notext.png +PROJECT_LOGO = contrib/libsigrok_112x112.png # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. 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 = 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 @@ -144,7 +144,7 @@ FULL_PATH_NAMES = YES # 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 @@ -580,7 +580,7 @@ STRICT_PROTO_MATCHING = NO # documentation. # The default value is: YES. -GENERATE_TODOLIST = YES +GENERATE_TODOLIST = NO # 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 @@ -743,7 +743,7 @@ WARN_LOGFILE = # spaces. # Note: If this tag is empty the current directory is searched. -INPUT = . +INPUT = $(SRCDIR)src $(SRCDIR)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 @@ -763,7 +763,11 @@ INPUT_ENCODING = UTF-8 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, # *.qsf, *.as and *.js. -FILE_PATTERNS = +# BEWARE! DON'T set the variable to an empty value. Don't set the variable +# at all instead. See https://github.com/doxygen/doxygen/issues/7190 and +# https://sigrok.org/bugzilla/show_bug.cgi?id=1422 (can get reverted when +# the Doxygen version which causes the issue no longer is used in the wild). +## FILE_PATTERNS = # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. @@ -778,7 +782,10 @@ RECURSIVE = YES # 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 src/sw_limits.c +EXCLUDE += src/scpi.h # 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 @@ -797,20 +804,35 @@ EXCLUDE_SYMLINKS = NO # # 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/sw_limits.c: Non-public helpers, no public API stuff in there. +# - src/scpi.h: 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. +# - src/modbus/*: Non-public helpers, no public API stuff in there. +# - src/scale/*: 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/* -EXCLUDE_PATTERNS += */doxy/* +EXCLUDE_PATTERNS = */src/hardware/* */src/input/* */src/output/* */src/transform/* +EXCLUDE_PATTERNS += */src/scpi/* */src/dmm/* */src/lcr/* +EXCLUDE_PATTERNS += */src/modbus/* */src/scale/* +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