From 8abd937672303fce561757f3f3d71cb52875ae71 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E7=99=BD=E4=B8=80=E7=99=BE?= <72658127+bai-yi-bai@users.noreply.github.com> Date: Wed, 6 Dec 2023 21:21:13 +0800 Subject: add hint about pathway from doxygen to AsciiDoc by way of DocBookRx --- docs/modules/migrate/pages/docbook-xml.adoc | 15 +++++++++++++++ 1 file changed, 15 insertions(+) (limited to 'docs') diff --git a/docs/modules/migrate/pages/docbook-xml.adoc b/docs/modules/migrate/pages/docbook-xml.adoc index 46706c2a..a5e29b8a 100644 --- a/docs/modules/migrate/pages/docbook-xml.adoc +++ b/docs/modules/migrate/pages/docbook-xml.adoc @@ -17,3 +17,18 @@ You can read more about this initiative in the {url-docbookrx}#readme[README^]. The best thing about this tool is all the active users who are putting it through its paces. The more advanced the DocBook XML this tool tackles, and the more feedback we receive, the better the tool will become. Use it today to escape from XML hell! + +== From doxygen + +Doxygen can generate documentation in various output formats. +One of those formats is (DocBook) XML. +That means there's a pathway from doxygen to AsciiDoc by way of DocBookRx. + +To enable this feature (off by default), set the `GENERATE_DOCBOOK` tag to `YES` in the Doxygen configuration file. +When enabled, Doxygen will generate XML files that capture the structure of the code including all documentation. + +To begin the migration, first run the doxygen command to generate the DocBook XML output. +Then run DocBookRx on the XML files to generate AsciiDoc files. +You can now use Asciidoctor to convert the AsciiDoc files to a consumable output format such as HTML. + +Note that some post processing of the generated AsciiDoc may be necessary. -- cgit v1.2.3