1
=== modified file 'doc/java/manual/indexpage.dox'
2
--- doc/java/manual/indexpage.dox	2012-05-03 12:31:51 +0000
3
+++ doc/java/manual/indexpage.dox	2012-05-09 19:55:25 +0000
4
@@ -1,18 +1,10 @@
5
1
/*! \mainpage Java API Documentation
1
/*! \mainpage Java API Documentation
6
2
2
9
3
  Zorba ships with a Java language binding that provides some basic features in order to prepare and execute queries
3
  Zorba provides two Java language bindings: (1) a language binding generated using SWIG that is similar to the bindings for Ruby or Python and (2) a binding that implements the <a href="http://jcp.org/en/jsr/detail?id=225">XQuery API for Java (XQJ)</a>.
8
4
  with Zorba.
10
5
4
18
6
  For the moment, we provide a <a class="en" href="examples.html">set of examples</a> that show how this language binding can be used.
5
  Although, the XQJ binding is currently implemented entirely on top of the SWIG binding, we encourage people to only use the XQJ binding. The SWIG generated binding might be deprecated in the future.
12
7
  
13
8
  \section note Note for garbage collected languages
14
9
  Zorba requires that objects must be deleted in a certain order, which Garbage Collectors are not aware of. For that reason, 
15
10
  the Iterators created with XQuery.iterator() must be explicitly deleted with iterator.delete() before the XQuery 
16
11
  object is deleted.
17
12
  
19
13
6
20
14
  \example Test_Zorba.java
7
  \example Test_Zorba.java
23
15
   This is a simple example that demonstrate how to use the Zorba XQuery Engine to
8
   This is a simple example that demonstrate how to use the SWIG generated binding to create, compile, and execute queries.
22
16
   create, compile, and execute queries.
24
17
 */
9
 */
25
18
10
Status:	Merged
Approved by:	Matthias Brantner on 2012-05-09
Approved revision:	10827
Merged at revision:	10833
Proposed branch:	lp:~zorba-coders/zorba/doc-java-fix
Merge into:	lp:zorba
Diff against target:	24 lines (+3/-11) 1 file modified doc/java/manual/indexpage.dox (+3/-11)
To merge this branch:	bzr merge lp:~zorba-coders/zorba/doc-java-fix
Related bugs:	Link a bug report
Reviewer	Date Requested	Status
Matthias Brantner		Approve on 2012-05-09
Rodolfo Ochoa	2012-05-09	Approve on 2012-05-09
Review via email: mp+105258@code.launchpad.net
1	=== modified file 'doc/java/manual/indexpage.dox'
2	--- doc/java/manual/indexpage.dox 2012-05-03 12:31:51 +0000
3	+++ doc/java/manual/indexpage.dox 2012-05-09 19:55:25 +0000
4	@@ -1,18 +1,10 @@
5	1	/*! \mainpage Java API Documentation	1	/*! \mainpage Java API Documentation
6	2		2
9	3	Zorba ships with a Java language binding that provides some basic features in order to prepare and execute queries	3	Zorba provides two Java language bindings: (1) a language binding generated using SWIG that is similar to the bindings for Ruby or Python and (2) a binding that implements the <a href="http://jcp.org/en/jsr/detail?id=225">XQuery API for Java (XQJ)</a>.
8	4	with Zorba.
10	5		4
18	6	For the moment, we provide a <a class="en" href="examples.html">set of examples</a> that show how this language binding can be used.	5	Although, the XQJ binding is currently implemented entirely on top of the SWIG binding, we encourage people to only use the XQJ binding. The SWIG generated binding might be deprecated in the future.
12	7
13	8	\section note Note for garbage collected languages
14	9	Zorba requires that objects must be deleted in a certain order, which Garbage Collectors are not aware of. For that reason,
15	10	the Iterators created with XQuery.iterator() must be explicitly deleted with iterator.delete() before the XQuery
16	11	object is deleted.
17	12
19	13		6
20	14	\example Test_Zorba.java	7	\example Test_Zorba.java
23	15	This is a simple example that demonstrate how to use the Zorba XQuery Engine to	8	This is a simple example that demonstrate how to use the SWIG generated binding to create, compile, and execute queries.
22	16	create, compile, and execute queries.
24	17	*/	9	*/
25	18		10