Commit Graph

26 Commits

Author SHA1 Message Date
Uwe Hermann 3535a6eeee Fix an issue when building in directories that are symlinks.
Explicitly use SRCDIR and BUILDDIR in Doxyfile files to reference input
files. This seems to be a sufficient fix for an issue where the build
would fail when libsigrok/ was located in a directory that was a symlink.

This fixes bug #547.
2019-05-01 17:58:06 +02:00
Uwe Hermann f200d59ee2 Various Doxygen fixes. 2017-06-12 02:44:28 +02:00
Uwe Hermann 6b21d9a77e Rename sigrok-logo-notext.png to libsigrok_112x112.png.
This is more specific and prevents any potential issues e.g. when
multiple distro packages might ship with a generic file like
sigrok-logo-notext.png that's supposed to be installed in the same place.
2017-06-11 23:03:09 +02:00
Uwe Hermann efde67a107 Doxyfile*: Set GENERATE_TODOLIST to NO.
We don't really need or use this. Bugs/issues should go into Bugzilla.
2016-09-26 17:19:24 +02:00
Lars-Peter Clausen 580b94e4d7 sw_limits: Add documentation
Add documentation for the software limits module.

Signed-off-by: Lars-Peter Clausen <lars@metafoo.de>
2016-05-31 15:54:52 +02:00
Bartosz Golaszewski b1e034f758 Doxyfile: Make exclude patterns more specific.
Current exclude patterns lead to unwanted exclusion of all paths
containing common directory names like output, bindings etc. even
if those names occur higher in the directory structure.

Make exclude patterns more specific by prefixing them with src/.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>
2015-02-20 11:12:31 +01:00
Uwe Hermann e00b3f5897 Various Doxygen updates. 2015-02-17 15:57:21 +01:00
Marcus Comstedt 7f82ec4d72 Makefile.am: Fix doxygen invocation in out-of-tree build 2014-08-17 12:58:39 +02:00
Uwe Hermann 15aa3b0d0c Doxygen: Exclude more non-public files and directories. 2014-08-10 18:59:16 +02:00
Martin Ling 3532ed0125 C++ bindings: Reimplement enums.py using doxygen XML output instead of gccxml. 2014-08-10 15:47:13 +02:00
Bert Vermeulen a01eab4a08 Doxygen: Update paths. 2014-08-01 16:31:13 +02:00
Uwe Hermann f055494660 doxygen: Updated Doxyfile to doxygen 1.8.6. 2014-05-04 17:55:46 +02:00
Uwe Hermann 00f24b9fd8 Doxyfile/Doxyfile_internal: Ignore doxy/* when creating docs. 2013-12-27 15:50:27 +01:00
Uwe Hermann 170fbcb3f7 Doxyfile/Doxyfile_internal: Update to same 1.8.5 template, sync them.
This also makes the diff from Doxyfile to Doxyfile_internal more readable.

Also, put public API docs into doxy/html-api/, private stuff into
doxy/html-internal/.
2013-12-27 15:36:22 +01:00
Matthias Heidbrink 86fa0ef594 doxygen: Updated Doxyfile to doxygen 1.8.5. 2013-12-09 15:16:29 +01:00
Uwe Hermann fc1bb735e4 Doxyfile: Set version to "unreleased development snapshot". 2013-08-08 19:39:50 +02:00
Uwe Hermann b11df97ad5 Doxyfile: Change version to 0.2.1. 2013-08-07 16:21:58 +02:00
Uwe Hermann 01169de391 Doxyfile: Set version to "unreleased development snapshot". 2013-05-08 16:41:18 +02:00
Uwe Hermann a4fdbbe1c2 Doxyfile: Set version number to 0.2.0. 2013-05-04 15:55:11 +02:00
Uwe Hermann 63c290b984 Doxygen: Exclude bindings/. 2013-04-16 12:45:38 +02:00
Uwe Hermann 1a64618a2f Doxygen: Set SHOW_NAMESPACES=no.
Since this is a C project, a "Namespaces" page is not really useful.
2013-04-16 12:43:42 +02:00
Uwe Hermann 67b5fba8ca Doxygen: Exclude std.c and tests/*.
These don't contain any public API functions or macros and thus should
not appear in the ("public API" version of) the Doxygen docs.
2013-04-06 19:29:13 +02:00
Uwe Hermann d5f1d5382d Doxyfile: Various additions/improvements.
- Show a short project description, the libsigrok version (x.y.z or
   "unreleased development snapshot"), and the sigrok logo in the
   Doxygen output.

 - Ignore a bunch of files and directories which don't contain public
   libsigrok API anyway.

 - Remove the SR_API prefix from the Doxygen output (all
   functions/symbols in the output are part of the public API anyway).

 - Various changes of settings to get nicer and more useful output.
2012-10-22 11:56:17 +02:00
Uwe Hermann c63eac737c Doxyfile: Update to what doxygen 1.8.1.2 generates.
The new version has a number of neat improvements/features we could use.
2012-10-22 11:56:17 +02:00
Uwe Hermann ba0b1dc639 Doxygen config files: Initial configuration. 2011-02-08 23:59:14 +01:00
Uwe Hermann df66e48b0c Add doxygen config files for both libs. 2011-02-08 23:00:49 +01:00