.\" Adapted from the user's guide.

.TH GNATDOC 1 "21 MAY 2016" "GNU Ada Tools" "GNAT Programming Studio"
.SH NAME
gnatdoc \- extract documentation from Ada sources
.SH SYNOPSIS
\fBgnatdoc\fR \fB\-P\fIproject\fR[\fI.gpr\fR]
.SH DESCRIPTION
GNATdoc is a documentation tool for Ada which processes source files,
extracts documentation directly from the sources, and generates
annotated HTML files. It is based on the source cross\-reference
information (e.g. generated by GNAT for Ada files). This means that
you should ensure that cross\-reference information has been generated
before generating the documentation. It also relies on standard
comments that it extracts from the source code. The engine in charge
of extracting them coupled with the cross\-reference engine gives
GNATdoc all the flexibility needed to generate accurate documentation,
and report errors in case of wrong documentation.
.TP
\fB\-P \fIproject\fR[\fI.gpr\fR], \fB\-P\fIproject\fR[\fI.gpr\fR], \fB\-\-project=\fIproject\fR[\fI.gpr\fR]
path to the main GNAT project
.TP
\fB\-X\fIvariable=value\fR
set an external project variable
.TP
\fB\-R\fIARG\fR, \fB\-\-regexp=\fIARG\fR
only extract comments matching a regular expression
.TP
\fB\-b\fR
process bodies
extract documentation from package body if none is found in specification
.TP
\fB\-\-ignore\-files=\fIARG\fR
source files to ignore, separated by spaces or commas
.TP
\fB\-l\fR
extract comments located before the declaration, not after
.TP
\fB\-\-no\-subprojects\fR
restrict processing to the main project
.TP
\fB\-p\fR
process private part of packages
.TP
\fB\-q\fR
only display errors
.TP
\fB\-\-single\-file=\fIARG\fR
only process one source in this project
.TP
\fB\-w\fR
warn for fields, parameters or subprograms without documentation
.TP
\fB\-\-enable\-build
launch gprbuild on the project before processing it
.\" --output is of little interest as long as only HTML is available
\fB\-h\fR, \fB\-\-help\fR
display usage then exit
.SH "SEE ALSO"
\fBgprbuild\fR (1),
various user guides in the \fI/usr/share/doc/gnat-gps\fR directory
if the \fIgnat-gps-doc\fR Debian package is installed on your system,
and the full gprbuild manual at
\fIhttp://docs.adacore.com/gprbuild-docs/html/gprbuild_ug.html\fR.
.SH AUTHOR
The GNAT Programming Studio has been written and is maintained by Ada
Core Technologies. If you are interested in getting commercial support
for this software, please contact sales@gnat.com.

This manual page has been written by
Nicolas Boulenguez <nicolas@debian.org>
for Debian GNU/Linux.