X-Git-Url: https://sigrok.org/gitweb/?p=libsigrok.git;a=blobdiff_plain;f=Doxyfile;h=4665f424b515508e2ad207f3010a9a5de800d427;hp=4959e9aef0396b9eb3e00ac316196e6ec383efcd;hb=e4204b1757459a03c0a70849a659f27387edc295;hpb=580b94e4d762d21a018b3cf535fe8764c9cb1c6f diff --git a/Doxyfile b/Doxyfile index 4959e9ae..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,7 +51,7 @@ 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 @@ -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 = src include $(BUILDDIR)include/libsigrok +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. @@ -781,6 +785,7 @@ RECURSIVE = YES 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 @@ -807,6 +812,8 @@ EXCLUDE_SYMLINKS = NO # - 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. @@ -814,12 +821,15 @@ EXCLUDE_SYMLINKS = NO # - 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 = */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