Author: boisvert
Date: Sun Oct 17 18:40:53 2010
New Revision: 1023550
URL: http://svn.apache.org/viewvc?rev=1023550&view=rev
Log:
Add minimal doc for protobuf extension
Modified:
buildr/trunk/addon/buildr/protobuf.rb
Modified: buildr/trunk/addon/buildr/protobuf.rb
URL:
http://svn.apache.org/viewvc/buildr/trunk/addon/buildr/protobuf.rb?rev=1023550&r1=1023549&r2=1023550&view=diff
==============================================================================
--- buildr/trunk/addon/buildr/protobuf.rb (original)
+++ buildr/trunk/addon/buildr/protobuf.rb Sun Oct 17 18:40:53 2010
@@ -15,7 +15,20 @@
module Buildr
- # Provides Protocol buffer code generation tasks. Require explicitly using
<code>require "buildr/protobuf"</code>.
+
+ # Provides Protocol buffer code generation tasks.
+ #
+ # Require explicitly using <code>require "buildr/protobuf"</code>.
+ #
+ # Usage in your project:
+ #
+ # protoc _("path/to/proto/files")
+ #
+ # and also supports two options,
+ #
+ # :output => "target/generated/protoc" # this is the default
+ # :lang => "java" # defaults to compile.language
+ #
module Protobuf
class << self
def protoc(*args)
