56 lines
884 B
Plaintext
56 lines
884 B
Plaintext
|
=encoding utf8
|
||
|
|
|
||
|
|
=head1 NAME
|
||
|
|
|
||
|
|
gosudoc - documentation generator for the Gosu language
|
||
|
|
|
||
|
|
=head1 SYNOPSIS
|
||
|
|
|
||
|
|
gosudoc [I<options>]
|
||
|
|
|
||
|
|
=head1 DESCRIPTION
|
||
|
|
|
||
|
|
The B<gosudoc> tool generates API documentation from source files.
|
||
|
|
|
||
|
|
=head1 OPTIONS
|
||
|
|
|
||
|
|
=over
|
||
|
|
|
||
|
|
=item B<-externalDocs>
|
||
|
|
|
||
|
|
List of external documents.
|
||
|
|
|
||
|
|
=item B<-filters>
|
||
|
|
|
||
|
|
List of filters.
|
||
|
|
|
||
|
|
=item B<-help>
|
||
|
|
|
||
|
|
Print a synopsis of standard options.
|
||
|
|
|
||
|
|
=item B<-inputDirs>
|
||
|
|
|
||
|
|
List of source directories to process.
|
||
|
|
|
||
|
|
=item B<-output>
|
||
|
|
|
||
|
|
Directory to write output.
|
||
|
|
|
||
|
|
=item B<-verbose>
|
||
|
|
|
||
|
|
Output messages about what gosudoc is doing. Default: C<false>.
|
||
|
|
|
||
|
|
=back
|
||
|
|
|
||
|
|
In addition, the @E<lt>I<filename>E<gt> syntax may be used to read the above
|
||
|
|
options from a file.
|
||
|
|
|
||
|
|
=head1 LICENSE
|
||
|
|
|
||
|
|
Gosu is released under version 2.0 of the L<Apache
|
||
|
|
License|https://www.apache.org/licenses/LICENSE-2.0.txt>.
|
||
|
|
|
||
|
|
=head1 SEE ALSO
|
||
|
|
|
||
|
|
L<https://gosu-lang.github.io/>, L<gosu(1)>, L<gosuc(1)>.
|