No issue: fixing JavaDocs for release.

dkpro · Jun 27, 2014 · ce72735 · ce72735
1 parent 1afc47f
commit ce72735
Show file tree

Hide file tree

Showing 14 changed files with 180 additions and 468 deletions.
diff --git a/...gpl/src/main/java/de/tudarmstadt/ukp/dkpro/keyphrases/textgraphs/type/AnnotationPair.java b/...gpl/src/main/java/de/tudarmstadt/ukp/dkpro/keyphrases/textgraphs/type/AnnotationPair.java
@@ -18,70 +18,52 @@
 import org.apache.uima.jcas.tcas.Annotation;
 
 
-/** 
- * Updated by JCasGen Wed May 22 14:44:24 CEST 2013
- * XML source: /srv/workspace42/de.tudarmstadt.ukp.dkpro.keyphrases/de.tudarmstadt.ukp.dkpro.keyphrases.textgraphs/src/main/resources/desc/type/EdgeWeight.xml
- * @generated */
+
 public class AnnotationPair extends Annotation {
-  /** @generated
-   * @ordered 
-   */
   @SuppressWarnings ("hiding")
   public final static int typeIndexID = JCasRegistry.register(AnnotationPair.class);
-  /** @generated
-   * @ordered 
-   */
   @SuppressWarnings ("hiding")
   public final static int type = typeIndexID;
-  /** @generated  */
+
   @Override
   public              int getTypeIndexID() {return typeIndexID;}
 
-  /** Never called.  Disable default constructor
-   * @generated */
   protected AnnotationPair() {/* intentionally empty block */}
 
-  /** Internal - constructor used by generator 
-   * @generated */
+
   public AnnotationPair(int addr, TOP_Type type) {
     super(addr, type);
     readObject();
   }
 
-  /** @generated */
   public AnnotationPair(JCas jcas) {
     super(jcas);
     readObject();   
   } 
 
-  /** @generated */  
+
   public AnnotationPair(JCas jcas, int begin, int end) {
     super(jcas);
     setBegin(begin);
     setEnd(end);
     readObject();
   }   
 
-  /** <!-- begin-user-doc -->
-    * Write your own initialization here
-    * <!-- end-user-doc -->
-  @generated modifiable */
+
   private void readObject() {/*default - does nothing empty block */}
 
 
 
   //*--------------*
   //* Feature: Annotation1
 
-  /** getter for Annotation1 - gets 
-   * @generated */
+
   public Annotation getAnnotation1() {
     if (AnnotationPair_Type.featOkTst && ((AnnotationPair_Type)jcasType).casFeat_Annotation1 == null)
       jcasType.jcas.throwFeatMissing("Annotation1", "de.tudarmstadt.ukp.dkpro.keyphrases.textgraphs.type.AnnotationPair");
     return (Annotation)(jcasType.ll_cas.ll_getFSForRef(jcasType.ll_cas.ll_getRefValue(addr, ((AnnotationPair_Type)jcasType).casFeatCode_Annotation1)));}
 
-  /** setter for Annotation1 - sets  
-   * @generated */
+
   public void setAnnotation1(Annotation v) {
     if (AnnotationPair_Type.featOkTst && ((AnnotationPair_Type)jcasType).casFeat_Annotation1 == null)
       jcasType.jcas.throwFeatMissing("Annotation1", "de.tudarmstadt.ukp.dkpro.keyphrases.textgraphs.type.AnnotationPair");
@@ -91,15 +73,13 @@ public void setAnnotation1(Annotation v) {
   //*--------------*
   //* Feature: Annotation2
 
-  /** getter for Annotation2 - gets 
-   * @generated */
+
   public Annotation getAnnotation2() {
     if (AnnotationPair_Type.featOkTst && ((AnnotationPair_Type)jcasType).casFeat_Annotation2 == null)
       jcasType.jcas.throwFeatMissing("Annotation2", "de.tudarmstadt.ukp.dkpro.keyphrases.textgraphs.type.AnnotationPair");
     return (Annotation)(jcasType.ll_cas.ll_getFSForRef(jcasType.ll_cas.ll_getRefValue(addr, ((AnnotationPair_Type)jcasType).casFeatCode_Annotation2)));}
 
-  /** setter for Annotation2 - sets  
-   * @generated */
+
   public void setAnnotation2(Annotation v) {
     if (AnnotationPair_Type.featOkTst && ((AnnotationPair_Type)jcasType).casFeat_Annotation2 == null)
       jcasType.jcas.throwFeatMissing("Annotation2", "de.tudarmstadt.ukp.dkpro.keyphrases.textgraphs.type.AnnotationPair");
@@ -109,15 +89,13 @@ public void setAnnotation2(Annotation v) {
   //*--------------*
   //* Feature: StringRepresentation1
 
-  /** getter for StringRepresentation1 - gets 
-   * @generated */
+
   public String getStringRepresentation1() {
     if (AnnotationPair_Type.featOkTst && ((AnnotationPair_Type)jcasType).casFeat_StringRepresentation1 == null)
       jcasType.jcas.throwFeatMissing("StringRepresentation1", "de.tudarmstadt.ukp.dkpro.keyphrases.textgraphs.type.AnnotationPair");
     return jcasType.ll_cas.ll_getStringValue(addr, ((AnnotationPair_Type)jcasType).casFeatCode_StringRepresentation1);}
 
-  /** setter for StringRepresentation1 - sets  
-   * @generated */
+
   public void setStringRepresentation1(String v) {
     if (AnnotationPair_Type.featOkTst && ((AnnotationPair_Type)jcasType).casFeat_StringRepresentation1 == null)
       jcasType.jcas.throwFeatMissing("StringRepresentation1", "de.tudarmstadt.ukp.dkpro.keyphrases.textgraphs.type.AnnotationPair");
@@ -127,15 +105,13 @@ public void setStringRepresentation1(String v) {
   //*--------------*
   //* Feature: StringRepresentation2
 
-  /** getter for StringRepresentation2 - gets 
-   * @generated */
+
   public String getStringRepresentation2() {
     if (AnnotationPair_Type.featOkTst && ((AnnotationPair_Type)jcasType).casFeat_StringRepresentation2 == null)
       jcasType.jcas.throwFeatMissing("StringRepresentation2", "de.tudarmstadt.ukp.dkpro.keyphrases.textgraphs.type.AnnotationPair");
     return jcasType.ll_cas.ll_getStringValue(addr, ((AnnotationPair_Type)jcasType).casFeatCode_StringRepresentation2);}
 
-  /** setter for StringRepresentation2 - sets  
-   * @generated */
+
   public void setStringRepresentation2(String v) {
     if (AnnotationPair_Type.featOkTst && ((AnnotationPair_Type)jcasType).casFeat_StringRepresentation2 == null)
       jcasType.jcas.throwFeatMissing("StringRepresentation2", "de.tudarmstadt.ukp.dkpro.keyphrases.textgraphs.type.AnnotationPair");

diff --git a/...rc/main/java/de/tudarmstadt/ukp/dkpro/keyphrases/textgraphs/type/AnnotationPair_Type.java b/...rc/main/java/de/tudarmstadt/ukp/dkpro/keyphrases/textgraphs/type/AnnotationPair_Type.java
@@ -22,14 +22,11 @@
 import org.apache.uima.cas.Feature;
 import org.apache.uima.jcas.tcas.Annotation_Type;
 
-/** 
- * Updated by JCasGen Wed May 22 14:44:24 CEST 2013
- * @generated */
 public class AnnotationPair_Type extends Annotation_Type {
-  /** @generated */
+
   @Override
   protected FSGenerator getFSGenerator() {return fsGenerator;}
-  /** @generated */
+
   private final FSGenerator fsGenerator = 
     new FSGenerator() {
       public FeatureStructure createFS(int addr, CASImpl cas) {
@@ -45,79 +42,77 @@ public FeatureStructure createFS(int addr, CASImpl cas) {
         } else return new AnnotationPair(addr, AnnotationPair_Type.this);
   	  }
     };
-  /** @generated */
+
   @SuppressWarnings ("hiding")
   public final static int typeIndexID = AnnotationPair.typeIndexID;
-  /** @generated 
-     @modifiable */
   @SuppressWarnings ("hiding")
   public final static boolean featOkTst = JCasRegistry.getFeatOkTst("de.tudarmstadt.ukp.dkpro.keyphrases.textgraphs.type.AnnotationPair");
 
-  /** @generated */
+
   final Feature casFeat_Annotation1;
-  /** @generated */
+
   final int     casFeatCode_Annotation1;
-  /** @generated */ 
+
   public int getAnnotation1(int addr) {
         if (featOkTst && casFeat_Annotation1 == null)
       jcas.throwFeatMissing("Annotation1", "de.tudarmstadt.ukp.dkpro.keyphrases.textgraphs.type.AnnotationPair");
     return ll_cas.ll_getRefValue(addr, casFeatCode_Annotation1);
   }
-  /** @generated */    
+
   public void setAnnotation1(int addr, int v) {
         if (featOkTst && casFeat_Annotation1 == null)
       jcas.throwFeatMissing("Annotation1", "de.tudarmstadt.ukp.dkpro.keyphrases.textgraphs.type.AnnotationPair");
     ll_cas.ll_setRefValue(addr, casFeatCode_Annotation1, v);}
 
 
 
-  /** @generated */
+
   final Feature casFeat_Annotation2;
-  /** @generated */
+
   final int     casFeatCode_Annotation2;
-  /** @generated */ 
+
   public int getAnnotation2(int addr) {
         if (featOkTst && casFeat_Annotation2 == null)
       jcas.throwFeatMissing("Annotation2", "de.tudarmstadt.ukp.dkpro.keyphrases.textgraphs.type.AnnotationPair");
     return ll_cas.ll_getRefValue(addr, casFeatCode_Annotation2);
   }
-  /** @generated */    
+
   public void setAnnotation2(int addr, int v) {
         if (featOkTst && casFeat_Annotation2 == null)
       jcas.throwFeatMissing("Annotation2", "de.tudarmstadt.ukp.dkpro.keyphrases.textgraphs.type.AnnotationPair");
     ll_cas.ll_setRefValue(addr, casFeatCode_Annotation2, v);}
 
 
 
-  /** @generated */
+
   final Feature casFeat_StringRepresentation1;
-  /** @generated */
+
   final int     casFeatCode_StringRepresentation1;
-  /** @generated */ 
+
   public String getStringRepresentation1(int addr) {
         if (featOkTst && casFeat_StringRepresentation1 == null)
       jcas.throwFeatMissing("StringRepresentation1", "de.tudarmstadt.ukp.dkpro.keyphrases.textgraphs.type.AnnotationPair");
     return ll_cas.ll_getStringValue(addr, casFeatCode_StringRepresentation1);
   }
-  /** @generated */    
+
   public void setStringRepresentation1(int addr, String v) {
         if (featOkTst && casFeat_StringRepresentation1 == null)
       jcas.throwFeatMissing("StringRepresentation1", "de.tudarmstadt.ukp.dkpro.keyphrases.textgraphs.type.AnnotationPair");
     ll_cas.ll_setStringValue(addr, casFeatCode_StringRepresentation1, v);}
 
 
 
-  /** @generated */
+
   final Feature casFeat_StringRepresentation2;
-  /** @generated */
+
   final int     casFeatCode_StringRepresentation2;
-  /** @generated */ 
+
   public String getStringRepresentation2(int addr) {
         if (featOkTst && casFeat_StringRepresentation2 == null)
       jcas.throwFeatMissing("StringRepresentation2", "de.tudarmstadt.ukp.dkpro.keyphrases.textgraphs.type.AnnotationPair");
     return ll_cas.ll_getStringValue(addr, casFeatCode_StringRepresentation2);
   }
-  /** @generated */    
+
   public void setStringRepresentation2(int addr, String v) {
         if (featOkTst && casFeat_StringRepresentation2 == null)
       jcas.throwFeatMissing("StringRepresentation2", "de.tudarmstadt.ukp.dkpro.keyphrases.textgraphs.type.AnnotationPair");
@@ -127,8 +122,7 @@ public void setStringRepresentation2(int addr, String v) {
 
 
 
-  /** initialize variables to correspond with Cas Type and Features
-	* @generated */
+
   public AnnotationPair_Type(JCas jcas, Type casType) {
     super(jcas, casType);
     casImpl.getFSClassRegistry().addGeneratorForType((TypeImpl)this.casType, getFSGenerator());