- dodana dokumentacja domyślnych wartości

git-svn-id: svn://svn.nlp.ipipan.waw.pl/morfeusz/trunk@291 ff4e3ee1-f430-4e82-ade0-24591c43f1fd

- dodana dokumentacja domyślnych wartości
git-svn-id: svn://svn.nlp.ipipan.waw.pl/morfeusz/trunk@291 ff4e3ee1-f430-4e82-ade0-24591c43f1fd
Michał Lenart
1 parent 57259a75
Showing 3 changed files with 78 additions and 63 deletions
morfeusz/morfeusz2.h
morfeusz/wrappers/morfeusz_java.i
morfeusz/wrappers/morfeusz_javadoc.i
@@ -34,9 +34,6 @@ namespace morfeusz {
  
     enum Charset {
         UTF8 = 11,
-        //    UTF16LE,
-        //    UTF16BE,
-        //    UTF32,
         ISO8859_2 = 12,
         CP1250 = 13,
         CP852 = 14
@@ -44,7 +41,7 @@ namespace morfeusz {
  
     enum TokenNumbering {
         /**
-         * Start from 0. Reset counter for every invocation of Morfeusz::analyze
+         * Start from 0. Reset counter for every invocation of Morfeusz::analyze (this is default)
          */
         SEPARATE_NUMBERING = 201,
  
@@ -56,7 +53,7 @@ namespace morfeusz {
  
     enum CaseHandling {
         /**
-         * Case-sensitive but allows interpretations that do not match case but there are no alternatives
+         * Case-sensitive but allows interpretations that do not match case but there are no alternatives (this is default)
          */
         CONDITIONALLY_CASE_SENSITIVE = 100,
  
@@ -73,7 +70,7 @@ namespace morfeusz {
  
     enum WhitespaceHandling {
         /**
-         * Ignore whitespaces
+         * Ignore whitespaces (this is default)
          */
         SKIP_WHITESPACES = 301,
  
@@ -210,7 +207,7 @@ namespace morfeusz {
         virtual Charset getCharset() const = 0;
  
         /**
-         * Select agglutination rules
+         * Select agglutination rules.
          * 
          * @param aggl
          * @remarks NOT THREAD-SAFE (must have exclusive access to this instance. Does not affect other Morfeusz instances).
@@ -113,62 +113,6 @@ namespace std {
     };
 }
  
-%typemap(javaimports) morfeusz::Morfeusz %{
-import java.io.IOException;
-import java.lang.RuntimeException;
-import java.util.List;
-import java.util.ArrayList;
-
-/**
- * Performs morphological analysis (analyse methods) and syntesis (generate methods).
- * 
- * It is NOT thread-safe
- * but it is possible to use separate Morfeusz instance for each concurrent thread.
- */
-%}
-
-%typemap(javaimports) morfeusz::ResultsIterator %{
-/**
- * Iterates through morphological analysis and synthesis results.
- * 
- */
-%}
-
-%typemap(javaimports) morfeusz::MorphInterpretation %{
-/**
- * <p>The result of morphological analysis or synthesis</p>
- * 
- * <p>
- * The result of analysis is  a directed acyclic graph with numbered
- * nodes representing positions  in text (points _between_ segments)
- * and edges representing interpretations of segments that span from
- * one node to another.  E.g.,
- * <pre>
- * {0,1,"ja","ja","ppron12:sg:nom:m1.m2.m3.f.n1.n2:pri"}
- *       |
- *       |      {1,2,"został","zostać","praet:sg:m1.m2.m3:perf"}
- *       |      |
- *     __|  ____|   __{2,3,"em","być","aglt:sg:pri:imperf:wok"}
- *    /  \ /     \ / \
- *   * Ja * został*em *
- *   0    1       2   3
- * </pre>
- * </p>
- * 
- * <p>
- * Note that the word 'zostałem' got broken into 2 separate segments.
- * </p>
-
- * <p>One MorphInterpretation instance describes one edge of this DAG.</p>
- */
-%}
-
-%typemap(javaimports) morfeusz::IdResolver %{
-/**
- * Represents mappings for tags, names and labels.
- */
-%}
-
 %rename(_dictionarySearchPaths) morfeusz::Morfeusz::dictionarySearchPaths;
 %rename(_getAvailableAgglOptions) morfeusz::Morfeusz::getAvailableAgglOptions;
 %rename(_getAvailablePraetOptions) morfeusz::Morfeusz::getAvailablePraetOptions;
+%typemap(javaimports) morfeusz::Morfeusz %{
+import java.io.IOException;
+import java.lang.RuntimeException;
+import java.util.List;
+import java.util.ArrayList;
+
+/**
+ * Performs morphological analysis (analyse methods) and syntesis (generate methods).
+ * 
+ * It is NOT thread-safe
+ * but it is possible to use separate Morfeusz instance for each concurrent thread.
+ */
+%}
+
+%typemap(javaimports) morfeusz::ResultsIterator %{
+/**
+ * Iterates through morphological analysis and synthesis results.
+ * 
+ */
+%}
+
+%typemap(javaimports) morfeusz::MorphInterpretation %{
+/**
+ * <p>The result of morphological analysis or synthesis</p>
+ * 
+ * <p>
+ * The result of analysis is  a directed acyclic graph with numbered
+ * nodes representing positions  in text (points _between_ segments)
+ * and edges representing interpretations of segments that span from
+ * one node to another.  E.g.,
+ * <pre>
+ * {0,1,"ja","ja","ppron12:sg:nom:m1.m2.m3.f.n1.n2:pri"}
+ *       |
+ *       |      {1,2,"został","zostać","praet:sg:m1.m2.m3:perf"}
+ *       |      |
+ *     __|  ____|   __{2,3,"em","być","aglt:sg:pri:imperf:wok"}
+ *    /  \ /     \ / \
+ *   * Ja * został*em *
+ *   0    1       2   3
+ * </pre>
+ * </p>
+ * 
+ * <p>
+ * Note that the word 'zostałem' got broken into 2 separate segments.
+ * </p>
+
+ * <p>One MorphInterpretation instance describes one edge of this DAG.</p>
+ */
+%}
+
+%typemap(javaimports) morfeusz::IdResolver %{
+/**
+ * Represents mappings for tags, names and labels.
+ */
+%}
+
+%typemap(javaimports) morfeusz::WhitespaceHandling %{
+/**
+ * Represents whitespace handling strategies (default is SKIP_WHITESPACES).
+ */
+%}
+
+%typemap(javaimports) morfeusz::CaseHandling %{
+/**
+ * Represents case handling strategies (default is CONDITIONALLY_CASE_SENSITIVE).
+ */
+%}
+
+%typemap(javaimports) morfeusz::TokenNumbering %{
+/**
+ * Represents token numbering strategies (default is SEPARATE_NUMBERING).
+ */
+%}
+
 %javamethodmodifiers morfeusz::Morfeusz::createInstance "
     /**
      * Creates actual instance of Morfeusz class.