Skip to content

Commit d9605f2

Browse files
author
automatic-merge
committed
Merge remote branch 'origin/master' into edge
2 parents d3541f5 + 103dc54 commit d9605f2

File tree

3 files changed

+19
-7
lines changed

3 files changed

+19
-7
lines changed

documentation/users_guide/backends.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,3 +63,10 @@ RST
6363

6464
The RST backend can be used to generate a set of *.rst* files to be used to generate
6565
documentation with *sphinx* configured with *ada-domain*.
66+
67+
68+
XML
69+
===
70+
71+
The XML backend can be used to generate documentation in XML format for
72+
processing with other tools.

documentation/users_guide/introduction.rst

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -50,16 +50,20 @@ A brief description of the supported switches is available through the
5050
Usage: gnatdoc [options] project_file
5151

5252
Options:
53-
--backend <name> Backend to use to generate output
54-
--generate <part> Part of code to generate documentation
53+
--backend <html|odf|rst|xml>
54+
Backend to use to generate output
55+
--generate <public|private|body>
56+
Part of code to generate documentation
57+
--style <leading|trailing|gnat>
58+
Use given style of documentation
5559
-O, --output-dir <output_dir>
5660
Output directory for generated documentation
5761
-P, --project <project_file>
5862
Project file to process
59-
--style <style> Use given style of documentation
6063
--warnings Report warnings for undocumented entities
6164
-v, --verbose Enable verbose output
62-
-X Set scenario variable
65+
-X <name=value> Specify an external reference for scenario
66+
variables
6367
-h, --help Display help information
6468

6569
Arguments:
@@ -78,8 +82,9 @@ Here is the list of supported switches:
7882

7983
* `--backend=<name>`: select the output format
8084

81-
GNATdoc generates HTML files (*--backend=html*), or ReST
82-
files (*--backend=rst*). The default is HTML.
85+
GNATdoc generates HTML files (*--backend=html*), OpenDocument Text document
86+
(*--backend-odf*), ReST files (*--backend=rst*), or XML file
87+
(*--backend=xml*). The default is HTML.
8388

8489
* `--generate=<part>`: Select the of entities to be included into the documentation
8590

source/gnatdoc/gnatdoc-command_line.adb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ package body GNATdoc.Command_Line is
4444
Backend_Option : constant VSS.Command_Line.Value_Option :=
4545
(Short_Name => <>,
4646
Long_Name => "backend",
47-
Value_Name => "html|odf|rst",
47+
Value_Name => "html|odf|rst|xml",
4848
Description => "Backend to use to generate output");
4949

5050
Generate_Option : constant VSS.Command_Line.Value_Option :=

0 commit comments

Comments
 (0)