Commit 309d2f0f526d5883429a5745d0b537c3b3a697ce

Authored by Michał Lenart
1 parent 57259a75

- dodana dokumentacja domyślnych wartości

git-svn-id: svn://svn.nlp.ipipan.waw.pl/morfeusz/trunk@291 ff4e3ee1-f430-4e82-ade0-24591c43f1fd
morfeusz/morfeusz2.h
... ... @@ -34,9 +34,6 @@ namespace morfeusz {
34 34  
35 35 enum Charset {
36 36 UTF8 = 11,
37   - // UTF16LE,
38   - // UTF16BE,
39   - // UTF32,
40 37 ISO8859_2 = 12,
41 38 CP1250 = 13,
42 39 CP852 = 14
... ... @@ -44,7 +41,7 @@ namespace morfeusz {
44 41  
45 42 enum TokenNumbering {
46 43 /**
47   - * Start from 0. Reset counter for every invocation of Morfeusz::analyze
  44 + * Start from 0. Reset counter for every invocation of Morfeusz::analyze (this is default)
48 45 */
49 46 SEPARATE_NUMBERING = 201,
50 47  
... ... @@ -56,7 +53,7 @@ namespace morfeusz {
56 53  
57 54 enum CaseHandling {
58 55 /**
59   - * Case-sensitive but allows interpretations that do not match case but there are no alternatives
  56 + * Case-sensitive but allows interpretations that do not match case but there are no alternatives (this is default)
60 57 */
61 58 CONDITIONALLY_CASE_SENSITIVE = 100,
62 59  
... ... @@ -73,7 +70,7 @@ namespace morfeusz {
73 70  
74 71 enum WhitespaceHandling {
75 72 /**
76   - * Ignore whitespaces
  73 + * Ignore whitespaces (this is default)
77 74 */
78 75 SKIP_WHITESPACES = 301,
79 76  
... ... @@ -210,7 +207,7 @@ namespace morfeusz {
210 207 virtual Charset getCharset() const = 0;
211 208  
212 209 /**
213   - * Select agglutination rules
  210 + * Select agglutination rules.
214 211 *
215 212 * @param aggl
216 213 * @remarks NOT THREAD-SAFE (must have exclusive access to this instance. Does not affect other Morfeusz instances).
... ...
morfeusz/wrappers/morfeusz_java.i
... ... @@ -113,62 +113,6 @@ namespace std {
113 113 };
114 114 }
115 115  
116   -%typemap(javaimports) morfeusz::Morfeusz %{
117   -import java.io.IOException;
118   -import java.lang.RuntimeException;
119   -import java.util.List;
120   -import java.util.ArrayList;
121   -
122   -/**
123   - * Performs morphological analysis (analyse methods) and syntesis (generate methods).
124   - *
125   - * It is NOT thread-safe
126   - * but it is possible to use separate Morfeusz instance for each concurrent thread.
127   - */
128   -%}
129   -
130   -%typemap(javaimports) morfeusz::ResultsIterator %{
131   -/**
132   - * Iterates through morphological analysis and synthesis results.
133   - *
134   - */
135   -%}
136   -
137   -%typemap(javaimports) morfeusz::MorphInterpretation %{
138   -/**
139   - * <p>The result of morphological analysis or synthesis</p>
140   - *
141   - * <p>
142   - * The result of analysis is a directed acyclic graph with numbered
143   - * nodes representing positions in text (points _between_ segments)
144   - * and edges representing interpretations of segments that span from
145   - * one node to another. E.g.,
146   - * <pre>
147   - * {0,1,"ja","ja","ppron12:sg:nom:m1.m2.m3.f.n1.n2:pri"}
148   - * |
149   - * | {1,2,"został","zostać","praet:sg:m1.m2.m3:perf"}
150   - * | |
151   - * __| ____| __{2,3,"em","być","aglt:sg:pri:imperf:wok"}
152   - * / \ / \ / \
153   - * * Ja * został*em *
154   - * 0 1 2 3
155   - * </pre>
156   - * </p>
157   - *
158   - * <p>
159   - * Note that the word 'zostałem' got broken into 2 separate segments.
160   - * </p>
161   -
162   - * <p>One MorphInterpretation instance describes one edge of this DAG.</p>
163   - */
164   -%}
165   -
166   -%typemap(javaimports) morfeusz::IdResolver %{
167   -/**
168   - * Represents mappings for tags, names and labels.
169   - */
170   -%}
171   -
172 116 %rename(_dictionarySearchPaths) morfeusz::Morfeusz::dictionarySearchPaths;
173 117 %rename(_getAvailableAgglOptions) morfeusz::Morfeusz::getAvailableAgglOptions;
174 118 %rename(_getAvailablePraetOptions) morfeusz::Morfeusz::getAvailablePraetOptions;
... ...
morfeusz/wrappers/morfeusz_javadoc.i
  1 +%typemap(javaimports) morfeusz::Morfeusz %{
  2 +import java.io.IOException;
  3 +import java.lang.RuntimeException;
  4 +import java.util.List;
  5 +import java.util.ArrayList;
  6 +
  7 +/**
  8 + * Performs morphological analysis (analyse methods) and syntesis (generate methods).
  9 + *
  10 + * It is NOT thread-safe
  11 + * but it is possible to use separate Morfeusz instance for each concurrent thread.
  12 + */
  13 +%}
  14 +
  15 +%typemap(javaimports) morfeusz::ResultsIterator %{
  16 +/**
  17 + * Iterates through morphological analysis and synthesis results.
  18 + *
  19 + */
  20 +%}
  21 +
  22 +%typemap(javaimports) morfeusz::MorphInterpretation %{
  23 +/**
  24 + * <p>The result of morphological analysis or synthesis</p>
  25 + *
  26 + * <p>
  27 + * The result of analysis is a directed acyclic graph with numbered
  28 + * nodes representing positions in text (points _between_ segments)
  29 + * and edges representing interpretations of segments that span from
  30 + * one node to another. E.g.,
  31 + * <pre>
  32 + * {0,1,"ja","ja","ppron12:sg:nom:m1.m2.m3.f.n1.n2:pri"}
  33 + * |
  34 + * | {1,2,"został","zostać","praet:sg:m1.m2.m3:perf"}
  35 + * | |
  36 + * __| ____| __{2,3,"em","być","aglt:sg:pri:imperf:wok"}
  37 + * / \ / \ / \
  38 + * * Ja * został*em *
  39 + * 0 1 2 3
  40 + * </pre>
  41 + * </p>
  42 + *
  43 + * <p>
  44 + * Note that the word 'zostałem' got broken into 2 separate segments.
  45 + * </p>
  46 +
  47 + * <p>One MorphInterpretation instance describes one edge of this DAG.</p>
  48 + */
  49 +%}
  50 +
  51 +%typemap(javaimports) morfeusz::IdResolver %{
  52 +/**
  53 + * Represents mappings for tags, names and labels.
  54 + */
  55 +%}
  56 +
  57 +%typemap(javaimports) morfeusz::WhitespaceHandling %{
  58 +/**
  59 + * Represents whitespace handling strategies (default is SKIP_WHITESPACES).
  60 + */
  61 +%}
  62 +
  63 +%typemap(javaimports) morfeusz::CaseHandling %{
  64 +/**
  65 + * Represents case handling strategies (default is CONDITIONALLY_CASE_SENSITIVE).
  66 + */
  67 +%}
  68 +
  69 +%typemap(javaimports) morfeusz::TokenNumbering %{
  70 +/**
  71 + * Represents token numbering strategies (default is SEPARATE_NUMBERING).
  72 + */
  73 +%}
  74 +
1 75 %javamethodmodifiers morfeusz::Morfeusz::createInstance "
2 76 /**
3 77 * Creates actual instance of Morfeusz class.
... ...