You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by bh...@apache.org on 2012/01/20 20:07:09 UTC
svn commit: r1234078 - in /uima/uimacpp/trunk: docs/ src/cas/uima/
src/framework/uima/
Author: bhavani
Date: Fri Jan 20 19:07:08 2012
New Revision: 1234078
URL: http://svn.apache.org/viewvc?rev=1234078&view=rev
Log:
UIMA-2356 fix warnings generated by doxygen
Modified:
uima/uimacpp/trunk/docs/uimacpp.dox
uima/uimacpp/trunk/src/cas/uima/cas.hpp
uima/uimacpp/trunk/src/cas/uima/sofastream.hpp
uima/uimacpp/trunk/src/cas/uima/sofastreamhandler.hpp
uima/uimacpp/trunk/src/framework/uima/annotator_context.hpp
uima/uimacpp/trunk/src/framework/uima/assertmsg.h
uima/uimacpp/trunk/src/framework/uima/casiterator.hpp
uima/uimacpp/trunk/src/framework/uima/consoleui.hpp
uima/uimacpp/trunk/src/framework/uima/cp2ucnvrt.hpp
uima/uimacpp/trunk/src/framework/uima/dllfile.hpp
uima/uimacpp/trunk/src/framework/uima/engine.hpp
uima/uimacpp/trunk/src/framework/uima/envvar.hpp
uima/uimacpp/trunk/src/framework/uima/exceptions.hpp
uima/uimacpp/trunk/src/framework/uima/taespecifierbuilder.hpp
uima/uimacpp/trunk/src/framework/uima/unistrref.hpp
Modified: uima/uimacpp/trunk/docs/uimacpp.dox
URL: http://svn.apache.org/viewvc/uima/uimacpp/trunk/docs/uimacpp.dox?rev=1234078&r1=1234077&r2=1234078&view=diff
==============================================================================
--- uima/uimacpp/trunk/docs/uimacpp.dox (original)
+++ uima/uimacpp/trunk/docs/uimacpp.dox Fri Jan 20 19:07:08 2012
@@ -420,6 +420,7 @@ INPUT = \
../src/framework/uima/assertmsg.h \
../src/framework/uima/capability.hpp \
../src/cas/uima/cas.hpp \
+ ../src/framework/uima/casiterator.hpp \
../src/framework/uima/casdefinition.hpp \
../src/cas/uima/casexception.hpp \
../src/framework/uima/caswriter_abase.hpp \
Modified: uima/uimacpp/trunk/src/cas/uima/cas.hpp
URL: http://svn.apache.org/viewvc/uima/uimacpp/trunk/src/cas/uima/cas.hpp?rev=1234078&r1=1234077&r2=1234078&view=diff
==============================================================================
--- uima/uimacpp/trunk/src/cas/uima/cas.hpp (original)
+++ uima/uimacpp/trunk/src/cas/uima/cas.hpp Fri Jan 20 19:07:08 2012
@@ -149,7 +149,7 @@ namespace uima {
* <li>A set of @link PreDefTypes predefined types@endlink,
* @link PreDefFeatures features@endlink,
* @link PreDefIndexes indexes@endlink and
- * @link UtilFuncts functions@endlink
+ * @link UtilFuncts Utility Functions@endlink
* for text analysis.
* </ol>
*/
@@ -243,7 +243,6 @@ namespace uima {
/**
* Add a copy of <code>crString</code> to the string heap.
* @param crString the string to add
- * @param bIsPermanent indicate if the string should be permanent, i.e., has a lifetime longer than the document
* @return an LString pointing to the new copy
*/
int addString(icu::UnicodeString const & crString);
@@ -252,14 +251,12 @@ namespace uima {
* Add a copy of <code>cpString</code> to the string heap.
* @param cpString a pointer to the string to copy (maynot be zero terminated)
* @param uiLen number of Unicode code units (not bytes!) to copy
- * @param bIsPermanent indicate if the string should be permanent, i.e., has a lifetime longer than the document
* @return an LString pointing to the new copy
*/
int addString(UChar const * cpString, size_t uiLen);
/**
* Add a copy of <code>uls</code> to the string heap.
* @param uls a pointer to the string to copy (maynot be zero terminated)
- * @param bIsPermanent indicate if the string should be permanent, i.e., has a lifetime longer than the document
* @return an LString pointing to the new copy
*/
int addString(const UnicodeStringRef & uls );
@@ -338,7 +335,7 @@ namespace uima {
/**
* Returns true if a CAS view.
- * @deprecated.
+ * @deprecated
*/
inline bool isView() {
return !isbaseCas;
@@ -370,7 +367,6 @@ namespace uima {
/**
* create an FS of type <code>crType</code>
* @param crType the type of FS to create
- * @param bIsPermanent indicate if the feature structure should be permanent, i.e., has a lifetime longer than the document
* @throws CouldNotCreateFSOfFinalTypeException
* @return the created feature structure
*/
@@ -380,8 +376,6 @@ namespace uima {
* create a feature structure of type FS Array.
* Each of the uiSize elements in the array is a FeatureStructure.
* @param uiSize the size of the array
- * @param bIsPermanent indicate if the data should be permanent,
- * i.e., has a lifetime longer than the document
*/
ArrayFS createArrayFS(size_t uiSize);
@@ -389,8 +383,6 @@ namespace uima {
* create a feature structure of type FS Array.
* Each of the uiSize elements in the array is a float.
* @param uiSize the size of the array
- * @param bIsPermanent indicate if the data should be permanent,
- * i.e., has a lifetime longer than the document
*/
FloatArrayFS createFloatArrayFS(size_t uiSize );
@@ -398,8 +390,6 @@ namespace uima {
* create a feature structure of type FS Array.
* Each of the uiSize elements in the array is a int.
* @param uiSize the size of the array
- * @param bIsPermanent indicate if the data should be permanent,
- * i.e., has a lifetime longer than the document
*/
IntArrayFS createIntArrayFS(size_t uiSize );
@@ -407,40 +397,30 @@ namespace uima {
* create a feature structure of type FS Array.
* Each of the uiSize elements in the array is a string.
* @param uiSize the size of the array
- * @param bIsPermanent indicate if the data should be permanent,
- * i.e., has a lifetime longer than the document
*/
StringArrayFS createStringArrayFS(size_t uiSize );
/**
* create a feature structure of type empty FS list (list length is zero)
* Each element in the list is a FeatureStructure.
- * @param bIsPermanent indicate if the feature structure should be permanent,
- * i.e., has a lifetime longer than the document
*/
ListFS createListFS();
/**
* create a feature structure of type empty float list (list length is zero).
* Each element in the list is a float.
- * @param bIsPermanent indicate if the feature structure should be permanent,
- * i.e., has a lifetime longer than the document
*/
FloatListFS createFloatListFS();
/**
* create a feature structure of type empty int list (list length is zero).
* Each element in the list is a int.
- * @param bIsPermanent indicate if the feature structure should be permanent,
- * i.e., has a lifetime longer than the document
*/
IntListFS createIntListFS();
/**
* create a feature structure of type empty string list (list length is zero).
* Each element in the list is a string.
- * @param bIsPermanent indicate if the feature structure should be permanent,
- * i.e., has a lifetime longer than the document
*/
StringListFS createStringListFS();
@@ -449,8 +429,6 @@ namespace uima {
* create a feature structure of type FS Array.
* Each of the uiSize elements in the array is a byte.
* @param uiSize the size of the array
- * @param bIsPermanent indicate if the data should be permanent,
- * i.e., has a lifetime longer than the document
*/
BooleanArrayFS createBooleanArrayFS(size_t uiSize );
@@ -459,8 +437,6 @@ namespace uima {
* create a feature structure of type FS Array.
* Each of the uiSize elements in the array is a byte.
* @param uiSize the size of the array
- * @param bIsPermanent indicate if the data should be permanent,
- * i.e., has a lifetime longer than the document
*/
ByteArrayFS createByteArrayFS(size_t uiSize );
@@ -469,8 +445,6 @@ namespace uima {
* create a feature structure of type FS Array.
* Each of the uiSize elements in the array is a short.
* @param uiSize the size of the array
- * @param bIsPermanent indicate if the data should be permanent,
- * i.e., has a lifetime longer than the document
*/
ShortArrayFS createShortArrayFS(size_t uiSize );
@@ -478,9 +452,7 @@ namespace uima {
/**
* create a feature structure of type FS Array.
* Each of the uiSize elements in the array is a long.
- * @param uiSize the size of the array
- * @param bIsPermanent indicate if the data should be permanent,
- * i.e., has a lifetime longer than the document
+ * @param uiSize the size of the arrayt
*/
LongArrayFS createLongArrayFS(size_t uiSize );
@@ -488,8 +460,6 @@ namespace uima {
* create a feature structure of type FS Array.
* Each of the uiSize elements in the array is a long.
* @param uiSize the size of the array
- * @param bIsPermanent indicate if the data should be permanent,
- * i.e., has a lifetime longer than the document
*/
DoubleArrayFS createDoubleArrayFS(size_t uiSize );
@@ -614,7 +584,7 @@ namespace uima {
*
* @param text
* The text to be analyzed.
- * @param mime
+ * @param mimetype
* The mime type of the data
* @exception CASException
* If the Sofa data has already been set, or View is base CAS.
@@ -701,9 +671,10 @@ namespace uima {
*/
FSIterator iterator() ;
- /**
- * @name CAS Utility functions for Annotations
- * @{ */
+
+ /** @defgroup UtilFuncts functions
+ * CAS Utility functions for Annotations
+ * @{ */
/**
* convenience function for creating an annotation.
* <code>type</code> must be a subtype of type Annotation.
@@ -714,12 +685,9 @@ namespace uima {
*/
virtual AnnotationFS createAnnotation( Type const & type, size_t uiBeginPos, size_t uiEndPos );
- /** @} */
/**
- * @name CAS Utility functions for Annotation Iterators
- * @{ */
- /**
+ * CAS Utility functions for Annotation Iterators
* sets the index iterator to the begin position of <code>crFromAnn</code>.
*
* @param itOfType The iterator to move
@@ -732,6 +700,7 @@ namespace uima {
* FeatureStructure must be annotations.
*/
bool moveToBeginPosition (ANIterator & itOfType, AnnotationFS const & crFromAnn);
+ /** @} defgroup */
/** @defgroup PreDefIndexes Predefined Indexes
* Only very few applications and annotators will need to create specific
@@ -770,6 +739,15 @@ namespace uima {
* @{ */
/**
+ * get the index over all annotations.
+ * The index is ordered where an annotation a1 is considered "less-than"
+ * another annotation a2 if the begin position of a1 is less then the begin
+ * position of a2, or, if they are equal, a1 is shorter than a2.
+ *
+ * @throws InvalidFSTypeObjectException
+ */
+ virtual ANIndex getAnnotationIndex();
+ /**
* get the index over annotations of type <code>crType</code>.
* The index is ordered where an annotation a1 is considered "less-than"
* another annotation a2 if the begin position of a1 is less then the begin
@@ -781,7 +759,6 @@ namespace uima {
*
* @throws InvalidFSTypeObjectException
*/
- virtual ANIndex getAnnotationIndex();
virtual ANIndex getAnnotationIndex(Type const & crType);
virtual ANIndex const getAnnotationIndex(Type const & crType) const;
@@ -1022,7 +999,7 @@ namespace uima {
* SofaIDs are the primary handle or access.
* <li><strong> Mime type </strong> : This string feature can be used to describe the type of the data represented by the Sofa.
* <li><strong>Sofa Data</strong> : The data itself. This data can be resident in the CAS or it can be a reference to data outside the CAS.
- * <eul>
+ * </ul>
* To create a Sofa FS, use CAS.createSofa().
* <br>
* <br>
@@ -1126,7 +1103,7 @@ namespace uima {
/**
* Get the Sofa Data Stream for the give Sofa FeatureStructure.
- * @param a valid SofA feature structure with values for one of
+ * @param fs a valid SofA feature structure with values for one of
* these feature -- sofaString, sofaArray, or sofaURI -- set.
* If the sofaURI feature has a valid value, a valid SofaDataStream
* is returned only if there is a stream handler registered
Modified: uima/uimacpp/trunk/src/cas/uima/sofastream.hpp
URL: http://svn.apache.org/viewvc/uima/uimacpp/trunk/src/cas/uima/sofastream.hpp?rev=1234078&r1=1234077&r2=1234078&view=diff
==============================================================================
--- uima/uimacpp/trunk/src/cas/uima/sofastream.hpp (original)
+++ uima/uimacpp/trunk/src/cas/uima/sofastream.hpp Fri Jan 20 19:07:08 2012
@@ -1,3 +1,6 @@
+#ifndef UIMA_SOFASTREAM_HPP
+#define UIMA_SOFASTREAM_HPP
+
/** \file sofastream.hpp .
-----------------------------------------------------------------------------
@@ -45,8 +48,7 @@
10/01/2004 Initial creation
-------------------------------------------------------------------------- */
-#ifndef UIMA_SOFASTREAM_HPP
-#define UIMA_SOFASTREAM_HPP
+
// ---------------------------------------------------------------------------
// Includes
@@ -136,8 +138,8 @@ namespace uima {
* at least elementSize*numElements in size.
*
* @param pbuffer
- * elementSize, e.g., 1, 2, 4, 8
- * numElements
+ * @param elementSize e.g., 1, 2, 4, 8
+ * @param numElements
* @return number of elements read
* -1 indicates EOF and no elements read
* -2 indicates elementSize is not compatible with elementSize
@@ -152,8 +154,8 @@ namespace uima {
* the specified offset from the specified origin.
* The origin is one of:
*
- * @param - offset, in number of bytes
- * origin as defined in stdio.h is one of
+ * @param offset in number of bytes
+ * @param origin as defined in stdio.h is one of
* SEEK_SET, from the start
* SEEK_CUR, from current location.
* SEEK_END, from end.
@@ -196,7 +198,7 @@ namespace uima {
public:
LocalSofaDataStream(SofaFS & sofaFS);
~LocalSofaDataStream();
- int open(size_t minbuf=0);
+ int open(size_t minbufsize=0);
INT64 getTotalStreamSizeInBytes();
INT64 howManyBytesAvailable();
int read( void * pbuffer, int elementSize, size_t numElements);
@@ -229,7 +231,7 @@ namespace uima {
public:
RemoteSofaDataStream(SofaFS& sofaFS);
~RemoteSofaDataStream();
- int open(size_t minbuf=0);
+ int open(size_t minbufsize=0);
INT64 getTotalStreamSizeInBytes();
INT64 howManyBytesAvailable();
int read( void * pbuffer, int elementSize, size_t numElements);
Modified: uima/uimacpp/trunk/src/cas/uima/sofastreamhandler.hpp
URL: http://svn.apache.org/viewvc/uima/uimacpp/trunk/src/cas/uima/sofastreamhandler.hpp?rev=1234078&r1=1234077&r2=1234078&view=diff
==============================================================================
--- uima/uimacpp/trunk/src/cas/uima/sofastreamhandler.hpp (original)
+++ uima/uimacpp/trunk/src/cas/uima/sofastreamhandler.hpp Fri Jan 20 19:07:08 2012
@@ -81,8 +81,8 @@ namespace uima {
* Advance the current position by the number of bytes read.
* This call blocks till read request is satisfied or EOF is
* reached.
- * @param numBytes, the number of bytes to read
- * @param pBuffer, buffer into which the bytes are to be copied.
+ * @param numBytes the number of bytes to read
+ * @param pBuffer buffer into which the bytes are to be copied.
* @returns number of bytes read of EOF (-1). This may be less than
* the number of bytes requested.
*/
@@ -92,7 +92,7 @@ namespace uima {
*
* Sets the position within the current stream.
*
- * @param offset - number of bytes from origin
+ * @param offset - number of bytes from origin
* @param origin is one of the following (taken from lseek spec):
* If SEEK_SET, the position is set to offset bytes.
* If SEEK_CUR, the position is set to its
@@ -100,7 +100,6 @@ namespace uima {
* If SEEK_END, the position is set to the total length
* plus offset bytes.
* These constants are defined in stdio.h
- *
* @return 0 indicates success
* -1 EOF
*/
Modified: uima/uimacpp/trunk/src/framework/uima/annotator_context.hpp
URL: http://svn.apache.org/viewvc/uima/uimacpp/trunk/src/framework/uima/annotator_context.hpp?rev=1234078&r1=1234077&r2=1234078&view=diff
==============================================================================
--- uima/uimacpp/trunk/src/framework/uima/annotator_context.hpp (original)
+++ uima/uimacpp/trunk/src/framework/uima/annotator_context.hpp Fri Jan 20 19:07:08 2012
@@ -119,7 +119,7 @@ namespace uima {
AnnotatorContext(AnalysisEngineDescription * taeSpec);
~AnnotatorContext(void);
-
+ /** @{ */
/**
* Return string config params as UTF-8--should be only if you know this is will work with
* you are dealing with single byte char set.
@@ -180,7 +180,7 @@ namespace uima {
/**
* Defines the CAS pool that this AnnotatorContext must support.
- * This method must be called before {@link AnnotatorContext#getEmptyCas()}
+ * This method must be called before {@link AnnotatorContext#getEmptyCAS()}
* may be called. A CASPool is defined by the framework when the components
* getCASInstancesRequired() returns a value greater than 0,
*/
Modified: uima/uimacpp/trunk/src/framework/uima/assertmsg.h
URL: http://svn.apache.org/viewvc/uima/uimacpp/trunk/src/framework/uima/assertmsg.h?rev=1234078&r1=1234077&r2=1234078&view=diff
==============================================================================
--- uima/uimacpp/trunk/src/framework/uima/assertmsg.h (original)
+++ uima/uimacpp/trunk/src/framework/uima/assertmsg.h Fri Jan 20 19:07:08 2012
@@ -73,7 +73,7 @@
There is no return value.
Example:
- \code
+ @code
foo(const void * cpvP1, const void * cpvP2, int i)
{
assert(EXISTS(cpvP1));
@@ -81,11 +81,12 @@
assert((i > 0) && (i < 100));
...
}
- \endcode
+ @endcode
+
\note <tt> assert</tt> is no longer implemented here ... the system macro is used.
Do not use the \#undef directive with <tt> assert</tt>.
- \line
+
<tt> assertWithMsg</tt> prints a diagnostic message to stderr and aborts the
program if expression is false (zero).
@@ -108,7 +109,7 @@
There is no return value.
Example:
- \code
+ @code
foo(const void * cpvP1, const void * cpvP2, int i)
{
assert(EXISTS(cpvP1));
@@ -116,7 +117,7 @@
assertWithMsg(((i > 0) && (i < 100)), "invalid value specified");
...
}
- \endcode
+ @endcode
\note <tt> assertWithMsg</tt> is implemented as a macro.
Do not use the \#undef directive with <tt> assertWithMsg</tt>.
Modified: uima/uimacpp/trunk/src/framework/uima/casiterator.hpp
URL: http://svn.apache.org/viewvc/uima/uimacpp/trunk/src/framework/uima/casiterator.hpp?rev=1234078&r1=1234077&r2=1234078&view=diff
==============================================================================
--- uima/uimacpp/trunk/src/framework/uima/casiterator.hpp (original)
+++ uima/uimacpp/trunk/src/framework/uima/casiterator.hpp Fri Jan 20 19:07:08 2012
@@ -22,6 +22,7 @@
* specific language governing permissions and limitations
* under the License.
+ \brief Contains class uima::CasIterator
-------------------------------------------------------------------------- */
#ifndef UIMA_CASITERATOR_HPP
#define UIMA_CASITERATOR_HPP
@@ -55,8 +56,8 @@ namespace uima {
namespace uima {
/**------------------------------------------------
- * CASPool
- * This class manages pool of CAS objects
+ * CASIterator
+ *
*------------------------------------------------
*/
Modified: uima/uimacpp/trunk/src/framework/uima/consoleui.hpp
URL: http://svn.apache.org/viewvc/uima/uimacpp/trunk/src/framework/uima/consoleui.hpp?rev=1234078&r1=1234077&r2=1234078&view=diff
==============================================================================
--- uima/uimacpp/trunk/src/framework/uima/consoleui.hpp (original)
+++ uima/uimacpp/trunk/src/framework/uima/consoleui.hpp Fri Jan 20 19:07:08 2012
@@ -98,6 +98,7 @@ namespace uima {
~ConsoleUI(void);
/*@}*/
+ /*@{*/
void setQuietMode(bool bQuiet) {
iv_bQuiet = bQuiet;
}
Modified: uima/uimacpp/trunk/src/framework/uima/cp2ucnvrt.hpp
URL: http://svn.apache.org/viewvc/uima/uimacpp/trunk/src/framework/uima/cp2ucnvrt.hpp?rev=1234078&r1=1234077&r2=1234078&view=diff
==============================================================================
--- uima/uimacpp/trunk/src/framework/uima/cp2ucnvrt.hpp (original)
+++ uima/uimacpp/trunk/src/framework/uima/cp2ucnvrt.hpp Fri Jan 20 19:07:08 2012
@@ -95,7 +95,7 @@ namespace uima {
using this code page converter */
size_t getMaximumLength(const char * cpacSource, size_t uiSourceLength) const;
-
+ /*@{*/
/** Using this code page converter, convert the specified source buffer
<TT>cpacSource</TT> with size <TT>uiSourceSize</TT> in bytes, to target
buffer <TT>pclTarget</TT> with size <TT>uiTargetMaxSize</TT> in bytes to
Modified: uima/uimacpp/trunk/src/framework/uima/dllfile.hpp
URL: http://svn.apache.org/viewvc/uima/uimacpp/trunk/src/framework/uima/dllfile.hpp?rev=1234078&r1=1234077&r2=1234078&view=diff
==============================================================================
--- uima/uimacpp/trunk/src/framework/uima/dllfile.hpp (original)
+++ uima/uimacpp/trunk/src/framework/uima/dllfile.hpp Fri Jan 20 19:07:08 2012
@@ -92,7 +92,7 @@ namespace uima {
* unloaded the DLL will cause unexpected results. (An application crash
* is very likely to happen.)
*
- * <b> NOTE: dropped the Cos Special Requirements for AIX 4.2 and below
+ * <b> NOTE: dropped the Cos Special Requirements for AIX 4.2 and below </b>
*
*/
class DllProcLoaderFile {
Modified: uima/uimacpp/trunk/src/framework/uima/engine.hpp
URL: http://svn.apache.org/viewvc/uima/uimacpp/trunk/src/framework/uima/engine.hpp?rev=1234078&r1=1234077&r2=1234078&view=diff
==============================================================================
--- uima/uimacpp/trunk/src/framework/uima/engine.hpp (original)
+++ uima/uimacpp/trunk/src/framework/uima/engine.hpp Fri Jan 20 19:07:08 2012
@@ -385,19 +385,19 @@ namespace uima {
virtual TyErrorId collectionProcessComplete() = 0;
- /**Processes a CAS, possibly producing multiple CASes as a result.
- * The application uses the {@link CasIterator} interface to step through the
+ /**Processes a <code>CAS</code>, possibly producing multiple CASes as a result.
+ * The application uses the {@link CASIterator } interface to step through the
* output CASes.
* <p>
* If this Analysis Engine does not produce output CASes, then the
- * <code>CasIterator</code> will return no elements.
+ * <code>CASIterator</code> will return no elements.
* <p>
* Once this method is called, the AnalysisEngine "owns" <code>aCAS</code>
- * until such time as the {@link CasIterator#hasNext()} method returns false.
+ * until such time as the {@link CASIterator#hasNext() } method returns false.
* That is, the caller should not attempt to modify or access the input CAS until
* it has read all of the elements from the CasIterator. If the caller wants to
* abort the processing before having read all of the output CASes, it may call
- * {@link CasIterator#release()}, which will stop further processing from
+ * {@link uima::CASIterator#release()}, which will stop further processing from
* occurring, and ownership of <code>aCAS</code> will revert to the caller.
*/
virtual CASIterator processAndOutputNewCASes(CAS &) =0;
@@ -441,7 +441,7 @@ namespace uima {
/**
- * @deprecate
+ * @deprecated
* A TextAnalysisEngine is an AnalysisEngine specialized for Text Analysis.
* It adds text specific support like language aware processing.
* It contains a specialized version of the CAS for text analysis, a uima::TCAS.
@@ -459,21 +459,21 @@ namespace uima {
virtual ~TextAnalysisEngine() {}
/** @name Creation functions */
/*@{*/
- /**@deprecate
+ /**@deprecated
* create a TextAnalysisEngine from a TAESpecifier. Returns NULL if creation failed.
* In such a case, <code>errorInfo</code> contains information about possible errors
* (output parameter).
*/
static TextAnalysisEngine * createTextAnalysisEngine(AnalysisEngineDescription &, ErrorInfo& errorInfo);
- /**@deprecate
+ /**@deprecated
* create a TextAnalysisEngine from the name of configuration file. Returns NULL if creation failed.
* In such a case, <code>errorInfo</code> contains information about possible errors
* (output parameter).
*/
static TextAnalysisEngine * createTextAnalysisEngine(char const * cpConfigFileName, ErrorInfo& errorInfo);
- /**@deprecate
+ /**@deprecated
* create a TextAnalysisEngine from an in-memory XML Buffer. Returns NULL if creation failed.
* In such a case, <code>errorInfo</code> contains information about possible errors
* (output parameter).
@@ -481,7 +481,7 @@ namespace uima {
static TextAnalysisEngine * createTextAnalysisEngine(UChar const * cpBuffer, size_t uiLength, ErrorInfo& errorInfo);
- /**@deprecate
+ /**@deprecated
* A lower level API for creating a TextAnalysisEngine
*/
static TextAnalysisEngine * createTAE(AnnotatorContext & rANC, bool bOwnsANC,
@@ -489,7 +489,7 @@ namespace uima {
uima::internal::CASDefinition & casDefinition,
bool ownsCASDefintion,
ErrorInfo &);
- /**@deprecate
+ /**@deprecated
* Creates a TAE from a file name if the first argument is true or
* an XML buffer if false.
*/
Modified: uima/uimacpp/trunk/src/framework/uima/envvar.hpp
URL: http://svn.apache.org/viewvc/uima/uimacpp/trunk/src/framework/uima/envvar.hpp?rev=1234078&r1=1234077&r2=1234078&view=diff
==============================================================================
--- uima/uimacpp/trunk/src/framework/uima/envvar.hpp (original)
+++ uima/uimacpp/trunk/src/framework/uima/envvar.hpp Fri Jan 20 19:07:08 2012
@@ -74,7 +74,7 @@ namespace uima {
/*@{*/
/** instantiate a new environment variable handler */
EnvironmentVariableQueryOnly(const char * cpszVar);
- /*@}*/
+
~EnvironmentVariableQueryOnly(void);
/*@}*/
/* --- selectors --- */
Modified: uima/uimacpp/trunk/src/framework/uima/exceptions.hpp
URL: http://svn.apache.org/viewvc/uima/uimacpp/trunk/src/framework/uima/exceptions.hpp?rev=1234078&r1=1234077&r2=1234078&view=diff
==============================================================================
--- uima/uimacpp/trunk/src/framework/uima/exceptions.hpp (original)
+++ uima/uimacpp/trunk/src/framework/uima/exceptions.hpp Fri Jan 20 19:07:08 2012
@@ -295,7 +295,8 @@ namespace uima {
Trying to load function begindoc.
File : extract.cpp
Function: ExternalAnnotator::tryGetProcAddress(char*)
- Line : 87\endcode
+ Line : 87
+ \endcode
*/
UIMA_LINK_IMPORTSPEC std::ostream &
operator << (
@@ -483,7 +484,8 @@ namespace uima {
While : Trying to initialize UIMACPP.
File : framewrk.cpp
Function: Framework::init(const IString&)
- Line : 128\endcode
+ Line : 128
+ \endcode
*/
UIMA_LINK_IMPORTSPEC std::ostream &
operator << (
@@ -672,7 +674,8 @@ namespace uima {
While : Trying to initialize UIMACPP.
File : framewrk.cpp
Function: Framework::init(const IString&)
- Line : 128\endcode
+ Line : 128
+ \endcode
*/
UIMA_LINK_IMPORTSPEC std::ostream &
operator << (
@@ -1048,7 +1051,8 @@ private:
While : Trying to initialize UIMACPP.
File : framewrk.cpp
Function: Framework::init(const IString&)
- Line : 128\endcode
+ Line : 128
+ \endcode
*/
//@{
//@}
Modified: uima/uimacpp/trunk/src/framework/uima/taespecifierbuilder.hpp
URL: http://svn.apache.org/viewvc/uima/uimacpp/trunk/src/framework/uima/taespecifierbuilder.hpp?rev=1234078&r1=1234077&r2=1234078&view=diff
==============================================================================
--- uima/uimacpp/trunk/src/framework/uima/taespecifierbuilder.hpp (original)
+++ uima/uimacpp/trunk/src/framework/uima/taespecifierbuilder.hpp Fri Jan 20 19:07:08 2012
@@ -94,7 +94,7 @@ namespace uima {
*
* @param aeDesc
* reference to <code>AnalysisEngineDescription</code> object
- * fileName
+ * @param fileName
* char buffer file containing the XML document to be parsed.
*
* @throws InvalidXMLException
@@ -107,7 +107,7 @@ namespace uima {
*
* @param aeDesc
* reference to <code>AnalysisEngineDescription</code> object
- * fileName
+ * @param fileName
* UnicodeStrin object containing the file name of the file cotaining the XML document.
*
* @throws InvalidXMLException
@@ -121,7 +121,7 @@ namespace uima {
*
* @param aeDesc
* reference to <code>AnalysisEngineDescription</code> object.
- * crInputSource
+ * @param crInputSource
* the input source from which to read the XML document.
*
*
@@ -135,7 +135,7 @@ namespace uima {
*
* @param aeDesc
* reference to <code>TypeSystemDescription</code> object.
- * crInputSource
+ * @param crInputSource
* the input source from which to read the XML document.
*
* @throws InvalidXMLException
@@ -149,7 +149,7 @@ namespace uima {
*
* @param fsDesc
* reference to <code>TyVecpFSIndexDescriptions</code> object.
- * crInputSource
+ * @param crInputSource
* the input source from which to read the XML document.
*
*
@@ -164,7 +164,7 @@ namespace uima {
*
* @param prioDesc
* reference to <code>TyVecpTypePriorities</code> object.
- * crInputSource
+ * @param crInputSource
* the input source from which to read the XML document.
*
* @throws InvalidXMLException
@@ -177,7 +177,7 @@ namespace uima {
* Caller assumes ownership of objects in the vector.
* @param sofaMapDesc
* reference to <code>TyVecpTypePriorities</code> object.
- * crInputSource
+ * @param crInputSource
* the input source from which to read the XML document.
*
* @throws InvalidXMLException
Modified: uima/uimacpp/trunk/src/framework/uima/unistrref.hpp
URL: http://svn.apache.org/viewvc/uima/uimacpp/trunk/src/framework/uima/unistrref.hpp?rev=1234078&r1=1234077&r2=1234078&view=diff
==============================================================================
--- uima/uimacpp/trunk/src/framework/uima/unistrref.hpp (original)
+++ uima/uimacpp/trunk/src/framework/uima/unistrref.hpp Fri Jan 20 19:07:08 2012
@@ -111,7 +111,9 @@ namespace uima {
///Assignment operator
UnicodeStringRef & operator=( UnicodeStringRef const & crclRHS );
- ///Equality operator
+ ///Index operator
+ inline UChar operator[]( int32_t offset ) const;
+ ///Equality operator
int operator==( const UnicodeStringRef & crclRHS ) const;
///Inequality operator
int operator!=( const UnicodeStringRef & crclRHS ) const;