Skip to main content
summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Struckmann2015-04-16 12:11:47 +0000
committerSebastian Struckmann2015-04-16 12:12:10 +0000
commit8dad9cfde33565cbc681400ba93899682d5f758e (patch)
tree51965e68c07a05c024d54879494e67d5868a7e7d /org.eclipse.jubula.documentation/developerManual
parent3571468b12b45e7f9ba4cb7c124544d64664b811 (diff)
downloadorg.eclipse.jubula.core-8dad9cfde33565cbc681400ba93899682d5f758e.tar.gz
org.eclipse.jubula.core-8dad9cfde33565cbc681400ba93899682d5f758e.tar.xz
org.eclipse.jubula.core-8dad9cfde33565cbc681400ba93899682d5f758e.zip
Sprint task - Adjusted documentation for the converter
Diffstat (limited to 'org.eclipse.jubula.documentation/developerManual')
-rw-r--r--org.eclipse.jubula.documentation/developerManual/en/docbook/clientAPI/sectionConverter.xml12
1 files changed, 6 insertions, 6 deletions
diff --git a/org.eclipse.jubula.documentation/developerManual/en/docbook/clientAPI/sectionConverter.xml b/org.eclipse.jubula.documentation/developerManual/en/docbook/clientAPI/sectionConverter.xml
index 882f4f4d4..b34ec620d 100644
--- a/org.eclipse.jubula.documentation/developerManual/en/docbook/clientAPI/sectionConverter.xml
+++ b/org.eclipse.jubula.documentation/developerManual/en/docbook/clientAPI/sectionConverter.xml
@@ -11,7 +11,7 @@
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xl="http://www.w3.org/1999/xlink">
<title>Converting a project into API (experimental)</title>
- <para>An existing Jubula project can be converted into the client-API. This following section will describe the limitations and how to install the converter.</para>
+ <para>An existing Jubula project can be converted to Java code which uses the client-API. This following section describes how to install the converter and what limitations are present.</para>
<section>
<title>Installing the converter plugin</title>
<orderedlist>
@@ -86,7 +86,7 @@
If there are problems during the conversion they will be shown in the console window or an error window will occur.
</para>
<para>
- For the converted project you need the <link xl:href="http://git.eclipse.org/c/jubula/org.eclipse.jubula.core.git/tree/org.eclipse.jubula.qa.api.converter.target.rcp/src/org/eclipse/jubula/qa/api/converter/target/rcp/RuntimeContext.java">RuntimeContext</link> and the <link xl:href="http://git.eclipse.org/c/jubula/org.eclipse.jubula.core.git/tree/org.eclipse.jubula.qa.api.converter.target.rcp/src/org/eclipse/jubula/qa/api/converter/target/rcp/VariableStore.java">VariableStore</link>. These classes are used in many places in the converted project.
+ For compiling the converted project you need two additional classes (<link xl:href="http://git.eclipse.org/c/jubula/org.eclipse.jubula.core.git/tree/org.eclipse.jubula.qa.api.converter.target.rcp/src/org/eclipse/jubula/qa/api/converter/target/rcp/RuntimeContext.java">RuntimeContext</link> and <link xl:href="http://git.eclipse.org/c/jubula/org.eclipse.jubula.core.git/tree/org.eclipse.jubula.qa.api.converter.target.rcp/src/org/eclipse/jubula/qa/api/converter/target/rcp/VariableStore.java">VariableStore</link>). These classes are used in many places in the converted project, therefore we recommend to use our provided <link xl:href="http://git.eclipse.org/c/jubula/org.eclipse.jubula.core.git/tree/org.eclipse.jubula.qa.api.converter.target.rcp/src-gen/">target project</link>.
</para>
</section>
<section>
@@ -94,13 +94,13 @@
<para>Current known limitations of the converter</para>
<itemizedlist>
<listitem>
- <para>Only one Test Case will be converted if another Test Case exists with the same name in the same category</para>
+ <para>If two Test Cases exist with the same name in the same category, only one of them will be converted</para>
</listitem>
<listitem>
- <para>Only one Test Job or Test Suite will be converted if another Test Job or Test Suite exists with the same name in the same category</para>
+ <para>If a Test Job and a Test Suite exist with the same name in the same category, only one of them will be converted</para>
</listitem>
<listitem>
- <para>Names of Test Cases,Test Suites and Test Jobs should match the Java conventions for class names. However we are doing some minor adjustments to names like removing spaces.<link xl:href="http://docs.oracle.com/javase/specs/jls/se7/html/jls-3.html#jls-3.8">Java language specification</link></para>
+ <para>Names of Test Cases,Test Suites and Test Jobs should match the Java conventions for class names. However we are doing some minor adjustments to names like removing spaces. (see <link xl:href="http://docs.oracle.com/javase/specs/jls/se7/html/jls-3.html#jls-3.8">Java language specification</link>)</para>
</listitem>
<listitem>
<para>Test Cases,Test Suites and Test Jobs should not begin with numbers</para>
@@ -115,7 +115,7 @@
<para>AUT configurations are not converted</para>
</listitem>
<listitem>
- <para>The first AUT is used to determine the toolkit</para>
+ <para>The first AUT is used to determine the toolkit of the project</para>
</listitem>
</itemizedlist>
</section>

Back to the top