.TH BREATHE-APIDOC "1" "October 2021" "breathe-apidoc 4.31.0" "User Commands"
.SH NAME
breathe-apidoc \- extract API documentation from Doxygen
.SH SYNOPSIS
.SY breathe-apidoc
.BR \-o " " \fIDESTDIR\fR
.OP \-f
.OP \-m
.OP \-n
.OP \-T
.OP \-s SUFFIX
.OP \-p PROJECT
.OP \-g TYPE
.OP \-q
.I PATH
.YS
.SH DESCRIPTION
.B breathe-apidoc
parses the XML output generated by
.BR doxygen (1)
and extracts the API documentation for use with Sphinx.
.PP
The following command line arguments are recognized:
.TP
PATH
the location of the index.xml file generated by Doxygen
.TP
.BR \-o " " \fIDESTDIR\fR ", " \-\-output " " \fIDESTDIR\fR
directory to place all output
.TP
.BR \-f ", " \-\-force
overwrite existing files
.TP
.BR \-m ", " \-\-members
include information about members of
.BR class ", " group ", " interface ", " namespace ", and " struct
types
.TP
.BR \-n ", " \-\-dry\-run
run the script without actually creating output files
.TP
.BR \-T ", " \-\-no-\-toc
do not create a table of contents files
.TP
.BR \-s " " \fISUFFIX\fR ", " \-\-suffix " " \fISUFFIX\fR
file extension for the created Sphinx input files (defaults to
.BR .rst ).
.TP
.BR \-p " " \fIPROJECT\fR ", " \-\-project " " \fIPROJECT\fR
add project
.I PROJECT
to generated directives
.TP
.BR \-q ", " \-\-quiet
suppress informational messages
.SH SEE ALSO
.BR doxygen (1)
.SH NOTE
This manual page was written for the Debian project by
.MT roehling@debian.org
Timo R\[u00F6]hling
.ME ,
and may be used without restriction.