.\"                                      Hey, EMACS: -*- nroff -*-
.TH DOXYPY 1 "January 17, 2010"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
doxypy \- Python input filter for Doxygen
.SH SYNOPSIS
.B doxypy
.RI [ options ] " files" ...
.SH DESCRIPTION
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
.\" respectively.
\fBdoxypy\fP is an input filter for Doxygen. It reformats Python comments
to conform to Doxygen documentation blocks. This makes it possible
to use the Doxygen/Javadoc syntax inside of docstrings when writing
code documentation and automatically generate API documentation out
of it instead of being forced to use non-Python documentation blocks
or to document code redundantly.
.SH OPTIONS
.TP
.B \-h, \-\-help
Show summary of options.
.TP
.B \-\-version
Show version of program.
.TP
.B \-\-autobrief
Use the docstring summary line as \\brief description.
.TP
.B \-\-debug
Enable debug output on stderr.
.SH SEE ALSO
.BR doxygen (1)
.SH AUTHOR
.B Philippe 'demod' Neumann <doxypy@demod.org>
.br
.B Gina 'foosel' Häußge <gina@foosel.net>
.PP
This manual page was written by \fBDavid Paleino <dapal@debian.org>\fR,
for the Debian project (and may be used by others).