a few more synopsis examples

mojolicious · Jul 30, 2012 · ab6921f · ab6921f
1 parent 0df68ec
commit ab6921f
Show file tree

Hide file tree

Showing 9 changed files with 23 additions and 7 deletions.
diff --git a/Changes b/Changes
@@ -1,5 +1,5 @@
 
-3.16  2012-07-30
+3.16  2012-07-31
   - Improved documentation.
 
 3.15  2012-07-28

diff --git a/lib/Mojolicious/Commands.pm b/lib/Mojolicious/Commands.pm
@@ -141,9 +141,8 @@ Mojolicious::Commands - Command line interface
 
   use Mojolicious::Commands;
 
-  # Command line interface
   my $commands = Mojolicious::Commands->new;
-  $commands->run(@ARGV);
+  push @{$commands->namespaces}, 'MyApp::Command';
 
 =head1 DESCRIPTION
 

diff --git a/lib/Mojolicious/Controller.pm b/lib/Mojolicious/Controller.pm
@@ -543,8 +543,17 @@ Mojolicious::Controller - Controller base class
 
 =head1 SYNOPSIS
 
+  # Controller
+  package MyApp::Foo;
   use Mojo::Base 'Mojolicious::Controller';
 
+  # Action
+  sub bar {
+    my $self = shift;
+    my $name = $self->param('name');
+    $self->render(json => {hello => $name});
+  }
+
 =head1 DESCRIPTION
 
 L<Mojolicious::Controller> is the base class for your L<Mojolicious>

diff --git a/lib/Mojolicious/Plugins.pm b/lib/Mojolicious/Plugins.pm
@@ -77,6 +77,7 @@ Mojolicious::Plugins - Plugin manager
   use Mojolicious::Plugins;
 
   my $plugins = Mojolicious::Plugin->new;
+  push @{$plugins->namespaces}, 'MyApp::Plugin';
 
 =head1 DESCRIPTION
 

diff --git a/lib/Mojolicious/Renderer.pm b/lib/Mojolicious/Renderer.pm
@@ -234,6 +234,8 @@ Mojolicious::Renderer - MIME type based renderer
   use Mojolicious::Renderer;
 
   my $renderer = Mojolicious::Renderer->new;
+  push @{$renderer->classes}, 'MyApp::Foo';
+  push @{renderer->paths}, '/home/sri/templates';
 
 =head1 DESCRIPTION
 

diff --git a/lib/Mojolicious/Sessions.pm b/lib/Mojolicious/Sessions.pm
@@ -81,6 +81,7 @@ Mojolicious::Sessions - Signed cookie based sessions
   use Mojolicious::Sessions;
 
   my $sessions = Mojolicious::Sessions->new;
+  $sessions->cookie_name('myapp');
 
 =head1 DESCRIPTION
 

diff --git a/lib/Mojolicious/Static.pm b/lib/Mojolicious/Static.pm
@@ -140,6 +140,8 @@ Mojolicious::Static - Serve static files
   use Mojolicious::Static;
 
   my $static = Mojolicious::Static->new;
+  push @{$static->classes}, 'MyApp::Foo';
+  push @{$static->paths}, '/home/sri/public';
 
 =head1 DESCRIPTION
 

diff --git a/lib/Mojolicious/Types.pm b/lib/Mojolicious/Types.pm
@@ -67,6 +67,8 @@ Mojolicious::Types - MIME types
   use Mojolicious::Types;
 
   my $types = Mojolicious::Types->new;
+  $types->type(foo => 'text/foo');
+  say $types->type('foo');
 
 =head1 DESCRIPTION
 

diff --git a/script/hypnotoad b/script/hypnotoad
@@ -31,10 +31,10 @@ usage: $0 [OPTIONS] [APPLICATION]
   hypnotoad -f myapp.pl
 
 These options are available:
-  -f, --foreground      Keep manager process in foreground.
-  -h, --help            Show this message.
-  -s, --stop            Stop server gracefully.
-  -t, --test            Test application and exit.
+  -f, --foreground   Keep manager process in foreground.
+  -h, --help         Show this message.
+  -s, --stop         Stop server gracefully.
+  -t, --test         Test application and exit.
 EOF
 
 # "This is it.