You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by sc...@apache.org on 2007/01/11 22:35:18 UTC

svn commit: r495388 - in /incubator/uima/uimaj/trunk/uima-docbooks/src/docbook: tools/tools.cde.xml tools/tools.jcasgen.xml tutorials_and_users_guides/annotator_analysis_engine_guide.xml

Author: schor
Date: Thu Jan 11 13:35:15 2007
New Revision: 495388

URL: http://svn.apache.org/viewvc?view=rev&rev=495388
Log:
UIMA-170 minor clarifications to JCasGen running on merged things.

Modified:
    incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.cde.xml
    incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.jcasgen.xml
    incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/annotator_analysis_engine_guide.xml

Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.cde.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.cde.xml?view=diff&rev=495388&r1=495387&r2=495388
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.cde.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.cde.xml Thu Jan 11 13:35:15 2007
@@ -683,10 +683,12 @@
     
   <warning><para>If the components of the aggregate have different definitions for the same 
     type name, the CDE will show a warning.  It is possible to continue past this warning, 
-    in which case the CDE will produce Java source files representing the merged types (that is, the
+    in which case the CDE will produce the correct 
+    Java source files representing the merged types (that is, the
     type definition that contains all of the features defined on that type by all of your
-    components).  However, it is not recommended to use this feature since it can make it 
-    difficult to combine your annotator with others. See <olink
+    components).  However, it is not recommended to use this feature 
+    (of having different definitions for the same type name) since it can make it 
+    difficult to combine/package your annotator with others. See <olink
       targetdoc="&uima_docs_ref;"
       targetptr="ugr.ref.jcas.merging_types_from_other_specs"/> for more information.
   </para></warning>    

Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.jcasgen.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.jcasgen.xml?view=diff&rev=495388&r1=495387&r2=495388
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.jcasgen.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.jcasgen.xml Thu Jan 11 13:35:15 2007
@@ -34,11 +34,14 @@
     the built-in type <literal>uima.tcas.DocumentAnnotation</literal>, see the warning below.) </para>
   
   <warning><para>If the components have different definitions for the same type name,
-    JCasGen will show a warning.  It is possible to continue past this warning, in which case 
-    JCasGen will produce Java source files representing the merged types (that is, the
+    JCasGen will show a warning, and in some environments may offer to abort the operation.
+    If you continue past this warning, 
+    JCasGen will produce Java source files representing the correctly merged types 
+   (that is, the
     type definition that contains all of the features defined on that type by all of your
-    components).  However, it is not recommended to use this feature since it can make it 
-    difficult to combine your annotator with others. See <olink
+    components).  It is recommended that you do not use this feature (of having 
+    two different definitions for the same type name) since it can make it 
+    difficult to combine/package your annotator with others. See <olink
       targetdoc="&uima_docs_ref;"
       targetptr="ugr.ref.jcas.merging_types_from_other_specs"/> for more information.
   </para>

Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/annotator_analysis_engine_guide.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/annotator_analysis_engine_guide.xml?view=diff&rev=495388&r1=495387&r2=495388
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/annotator_analysis_engine_guide.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/annotator_analysis_engine_guide.xml Thu Jan 11 13:35:15 2007
@@ -1161,7 +1161,8 @@
       
       <warning><para>If the components have different definitions for the same type name,
         The Component Descriptor Editor will show a warning.  It is possible to continue past
-        this warning, in which case your aggregate's type system will have a <quote>merged</quote>
+        this warning, in which case your aggregate's type system will have the correct
+        <quote>merged</quote>
         type definition that contains all of the features defined on that type by all of your
         components.  However, it is not recommended to use this feature in conjunction with JCAS,
         since the JCAS Java Class definitions cannot be so easily merged.  See