Changeset Navigation

Changeset 6031

Timestamp:

11/09/06 17:59:58

Author:

jan

Message:

improved documentation

Files:

r6029	r6031
50	50	end
51	51
	52	# this is needed by java - the factory gets stored internally
	53	# in a map, so it needs to return a hash code.
52	54	def hashCode # :nodoc:
53	55	123456
…	…
79	81
80	82	# A convenience method to serialize a list of found annotations
81		# to ~~+filename+ using yaml~~.
	83	# to file +filename+ (yaml format).
82	84	def annotated_classes_to_yaml(annotation, filename)
83	85	find_annotation annotation do \|classes\|
…	…
107	109	end
108	110
	111	# Calls all registered handlers.
109	112	def post_compile
110	113	super unless nocompile
…	…
115	118	end
116	119
117		def get_processor_factory
	120	def get_processor_factory # :nodoc:
118	121	Rjb::bind(self, 'com.sun.mirror.apt.AnnotationProcessorFactory')
119	122	end

r6030	r6031
102	102	end
103	103
104		# Wrapper class around _org.hibernate.tool.hbm2ddl.SchemaExport_.
	104	# Wrapper class around
	105	# {org.hibernate.tool.hbm2ddl.SchemaExport.}[http://www.hibernate.org/hib_docs/v3/api/org/hibernate/tool/hbm2ddl/SchemaExport.html]
105	106	class SchemaExporter
106	107	def initialize(classes, outputfile, dialect, package=nil)

r6029	r6031
122	122	end
123	123
124		# Tasks including this module can ~~specifi~~y additional
125		# Java style arguments (like -verbose, -gc).
	124	# Tasks including this module can easily specify additional
	125	# Java-style arguments (like -verbose, -gc).
126	126	#
127	127	# == Example
128	128	#
129	129	# Jerbil::MyExtraArgumentTakingTask.new do \|t\|
130		# t.~~foo = 'baz~~'
	130	# t.source = '1.5'
131	131	# t.options :wibble, :wobble
132	132	# end
133	133	#
134		# results in a command line of the form "-~~foo baz~~ -wibble -wobble".
	134	# results in a command line of the form "-source 1.5 -wibble -wobble".
135	135	module ExtraArgumentTaking
136	136	def self.append_features(base)
…	…
256	256	# A MultiJavaFileList is a container object for holding several JavaFileList
257	257	# objects. This is useful for multidirectory builds.
	258	#
	259	# == Example
	260	# SOURCE_DIR = "src"
	261	# MODULES = [ "a", "b" ]
	262	# JAVA_BUILD_DIR = "classes"
	263	# JAVA_FILES = MultiJavaFileList.new(MODULES, JAVA_BUILD_DIR, SOURCE_DIR)
	264	#
	265	# This will look for source files in +a/src+ and +b/src+, compiling into +classes+.
258	266	class MultiJavaFileList
259	267

r6029	r6031
9	9	# Jerbil::JavaTask.new(:run, "jerbil.sample.Main") do \|t\|
10	10	# t.classpath = CLASSPATH
11		# t.parameters = [ "-~~foo", "baz~~" ]
12		# t.~~sys_property "jerbil.foo", "baz"~~
	11	# t.parameters = [ "--quiet" ]
	12	# t.max_mem = 64
13	13	# t.fork = true
14	14	# t.depends_on :compile

r6029	r6031
4	4
5	5	module Jerbil
	6	# Compiles Java source files.
	7	# The location of the source files and the destionation directory is encapsulated
	8	# in a JavaFileList.
	9	#
6	10	# == Example
7	11	#

r6029	r6031
16	16	# end
17	17	#
	18	# The test classes can be specified by passing a Jerbil::JavaFileList to
	19	# +tests+, or by setting the location of xml test suites using +suites+.
18	20	class TestNGTask < Rake::TaskLib
19	21	include JavaHelper
…	…
175	177	# +classnames+:: a list of test class names.
176	178	# +suitename+:: name of the suite.
177		# +onetest++: whether all tests should be rolled into one.
178		# +excluded++: classes excluded from the test.
	179	# +onetest+:: whether all tests should be rolled into one.
	180	# +excluded+:: classes excluded from the test.
179	181	def create_suite_xml(filename, classnames, suitename="default", onetest=false, excluded = [])
180	182

r6029	r6031
8	8	require 'jerbil/jibx_task'
9	9	require 'jerbil/hibernate_task'
10		~~require 'jerbil/hibernate_task2'~~