summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKaren Arutyunov <karen@codesynthesis.com>2023-08-31 22:59:56 +0300
committerKaren Arutyunov <karen@codesynthesis.com>2023-09-04 15:56:50 +0300
commit0c40310afde1d595697d0edfb3b174a9738605cf (patch)
tree2883a3f6bd15f84176cdd603f76bff11c5ad0c58 /README.md
parent98afb7b5eafb0dc18b723d085c101d5e514913e4 (diff)
Generate doxygen documentation using dynamic target extraction
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 7 insertions, 3 deletions
diff --git a/README.md b/README.md
index 64284bb..aa2908a 100644
--- a/README.md
+++ b/README.md
@@ -23,9 +23,13 @@ bdep init @target -d libxsd -d libxsd-tests -d xsd-tests -d xsd-examples
```
-To generate the documentation in the `.ps` and `.pdf` formats, `html2ps` and
-`ps2pdf14` programs are required (the latter is from `ghostscript`). A warning
-is issued in the development mode if these programs are not available.
+To generate the documentation in the `.ps` and `.pdf` formats, the `html2ps`
+and `ps2pdf14` programs are required (the latter is from `ghostscript`). A
+warning is issued in the development mode if these programs are not available.
+
+To generate the Doxygen documentation (in `libxsd`) the `doxygen` program is
+required. Currently this functionality is only enabled if `libxsd` is
+initialized with explicit `config.libxsd.doxygen=true`.
To test installation of the XSD compiler, create a separate target
configuration (it will automatically resolve any build-time dependencies from