[DRE-commits] [SCM] yard.git branch, master, updated. debian/0.8.1-1-24-g6a006a9
Cédric Boutillier
boutil at debian.org
Tue May 7 13:54:15 UTC 2013
The following commit has been merged in the master branch:
commit 76fe2140c1918d71c3039a6c11ccfeb72d6881fe
Author: Cédric Boutillier <boutil at debian.org>
Date: Tue May 7 14:43:45 2013 +0200
update manpages
diff --git a/debian/yard.1.pod b/debian/yard.1.pod
index 54db010..9ce1f4f 100644
--- a/debian/yard.1.pod
+++ b/debian/yard.1.pod
@@ -31,6 +31,10 @@ Views or edits current global configuration
Returns the object diff of two gems or .yardoc files
+=item B<display>
+
+Displays a formatted object
+
=item B<doc>
Generates documentation. B<yardoc>(1) is a synonym of B<yard> B<doc>.
@@ -55,6 +59,10 @@ Generates .pot file from source code and extra documentation
Lists all constant and methods. Uses B<yard> B<doc> B<--list>.
+=item B<markups>
+
+Lists all available markup types and libraries
+
=item B<ri>
A tool to view documentation in the console like B<ri>(1). B<yri>(1) is a synonym of B<yard> B<ri>.
diff --git a/debian/yardoc.1.pod b/debian/yardoc.1.pod
index 51fd3a8..7531b1c 100644
--- a/debian/yardoc.1.pod
+++ b/debian/yardoc.1.pod
@@ -8,6 +8,7 @@ yardoc - Ruby tool to generate documentation for the Ruby programming language
=head1 SYNOPSIS
B<yarddoc> [I<options>] [I<source_files> [- I<extra_files>]]
+B<yard doc> [I<options>] [I<source_files> [- I<extra_files>]]
=head1 DESCRIPTION
@@ -17,7 +18,7 @@ language. It enables the user to generate consistent, usable documentation that
can be exported to a number of formats very easily, and also supports extending
for custom Ruby constructs such as custom class level definitions.
-B<yardoc>, synony for B<yard> B<doc> generates the documentation from the
+B<yardoc>, synonym for B<yard> B<doc> generates the documentation from the
list of I<source_files>. If this list is omitted,
C<{lib,app}/**/*.rb ext/**/*.c> is used.
@@ -180,6 +181,14 @@ The output format for the template (defaults to html).
Don't print statistics
+=item B<--locale> I<LOCALE>
+
+The locale for generated documentation (defaults to en).
+
+=item B<--po-dir> I<DIR>
+
+The directory that has .po files (defaults to #{YARD::Registry.po_dir}).
+
=back
=head2 Tag options:
@@ -214,7 +223,11 @@ Hides a previously defined tag from templates
=item B<--transitive-tag> I<TAG>
-Adds a transitive tag
+Marks a tag as transitive
+
+=item B<--non-transitive-tag> I<TAG>
+
+Marks a tag as not transitive
=back
--
yard.git
More information about the Pkg-ruby-extras-commits
mailing list