[fdo-commits] r2520 - in trunk/Fdo/Unmanaged/Inc/Common: . Io Xml
Xsl
svn_fdo at osgeo.org
svn_fdo at osgeo.org
Thu Feb 15 14:23:49 EST 2007
Author: gregboone
Date: 2007-02-15 14:23:49 -0500 (Thu, 15 Feb 2007)
New Revision: 2520
Modified:
trunk/Fdo/Unmanaged/Inc/Common/Array.h
trunk/Fdo/Unmanaged/Inc/Common/Compare.h
trunk/Fdo/Unmanaged/Inc/Common/Context.h
trunk/Fdo/Unmanaged/Inc/Common/Dictionary.h
trunk/Fdo/Unmanaged/Inc/Common/DictionaryElement.h
trunk/Fdo/Unmanaged/Inc/Common/Dimensionality.h
trunk/Fdo/Unmanaged/Inc/Common/Disposable.h
trunk/Fdo/Unmanaged/Inc/Common/Exception.h
trunk/Fdo/Unmanaged/Inc/Common/FdoTypes.h
trunk/Fdo/Unmanaged/Inc/Common/GeometryType.h
trunk/Fdo/Unmanaged/Inc/Common/IStreamReader.h
trunk/Fdo/Unmanaged/Inc/Common/Io/ByteStreamReader.h
trunk/Fdo/Unmanaged/Inc/Common/Io/FileStream.h
trunk/Fdo/Unmanaged/Inc/Common/Io/MemoryStream.h
trunk/Fdo/Unmanaged/Inc/Common/Io/Stream.h
trunk/Fdo/Unmanaged/Inc/Common/Io/TextReader.h
trunk/Fdo/Unmanaged/Inc/Common/Io/TextWriter.h
trunk/Fdo/Unmanaged/Inc/Common/NamedCollection.h
trunk/Fdo/Unmanaged/Inc/Common/Ptr.h
trunk/Fdo/Unmanaged/Inc/Common/Semaphore.h
trunk/Fdo/Unmanaged/Inc/Common/Stack.h
trunk/Fdo/Unmanaged/Inc/Common/StringP.h
trunk/Fdo/Unmanaged/Inc/Common/Vector.h
trunk/Fdo/Unmanaged/Inc/Common/Xml/Attribute.h
trunk/Fdo/Unmanaged/Inc/Common/Xml/AttributeCollection.h
trunk/Fdo/Unmanaged/Inc/Common/Xml/CharDataHandler.h
trunk/Fdo/Unmanaged/Inc/Common/Xml/CopyHandler.h
trunk/Fdo/Unmanaged/Inc/Common/Xml/Reader.h
trunk/Fdo/Unmanaged/Inc/Common/Xml/SaxContext.h
trunk/Fdo/Unmanaged/Inc/Common/Xml/SaxHandler.h
trunk/Fdo/Unmanaged/Inc/Common/Xml/SkipElementHandler.h
trunk/Fdo/Unmanaged/Inc/Common/Xml/Writer.h
trunk/Fdo/Unmanaged/Inc/Common/Xml/XmlException.h
trunk/Fdo/Unmanaged/Inc/Common/Xsl/Transformer.h
Log:
FDO4: API - Update API documentation included in the FDO header files
Modified: trunk/Fdo/Unmanaged/Inc/Common/Array.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Common/Array.h 2007-02-15 17:36:56 UTC (rev 2519)
+++ trunk/Fdo/Unmanaged/Inc/Common/Array.h 2007-02-15 19:23:49 UTC (rev 2520)
@@ -344,14 +344,17 @@
*(this->GetData()+i) = newElement;
}
+/// \ingroup (typedefs)
/// \brief
/// Dynamic array of bytes (FdoByte).
typedef FdoArray<FdoByte> FdoByteArray;
+/// \ingroup (typedefs)
/// \brief
/// Dynamic array of doubles (FdoDouble).
typedef FdoArray<FdoDouble> FdoDoubleArray;
+/// \ingroup (typedefs)
/// \brief
/// Dynamic array of integers (FdoInt32).
typedef FdoArray<FdoInt32> FdoIntArray;
Modified: trunk/Fdo/Unmanaged/Inc/Common/Compare.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Common/Compare.h 2007-02-15 17:36:56 UTC (rev 2519)
+++ trunk/Fdo/Unmanaged/Inc/Common/Compare.h 2007-02-15 19:23:49 UTC (rev 2520)
@@ -23,6 +23,7 @@
#endif
/// \cond DOXYGEN-IGNORE
+
/// \brief
/// FdoCompareType is an enumeration of different value comparison results when comparing
/// value1 and value2
@@ -43,7 +44,9 @@
FdoCompareType_Greater,
FdoCompareType_Equal
};
+/// \endcond
+/// \cond DOXYGEN-IGNORE
// General function for comparing values of simple types or types that define the comparison operators.
template< class T> FdoCompareType FdoCompare( T val1, T val2 )
{
Modified: trunk/Fdo/Unmanaged/Inc/Common/Context.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Common/Context.h 2007-02-15 17:36:56 UTC (rev 2519)
+++ trunk/Fdo/Unmanaged/Inc/Common/Context.h 2007-02-15 19:23:49 UTC (rev 2520)
@@ -81,6 +81,7 @@
FdoPtr<Errors> mErrors;
};
+/// \ingroup (typedefs)
/// \brief
/// FdoContextP is a FdoPtr on FdoContext, provided for convenience.
typedef FdoPtr<FdoContext> FdoContextP;
Modified: trunk/Fdo/Unmanaged/Inc/Common/Dictionary.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Common/Dictionary.h 2007-02-15 17:36:56 UTC (rev 2519)
+++ trunk/Fdo/Unmanaged/Inc/Common/Dictionary.h 2007-02-15 19:23:49 UTC (rev 2520)
@@ -46,6 +46,7 @@
};
+/// \ingroup (typedefs)
/// \brief
/// FdoDictionaryP is a FdoPtr on FdoDictionary, provided for convenience.
typedef FdoPtr<FdoDictionary> FdoDictionaryP;
Modified: trunk/Fdo/Unmanaged/Inc/Common/DictionaryElement.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Common/DictionaryElement.h 2007-02-15 17:36:56 UTC (rev 2519)
+++ trunk/Fdo/Unmanaged/Inc/Common/DictionaryElement.h 2007-02-15 19:23:49 UTC (rev 2520)
@@ -34,7 +34,7 @@
///
/// \param name
/// Input the name of the element (required)
- /// \param name
+ /// \param value
/// Input the value of the element. Can be blank (L"")
///
/// \return
@@ -79,8 +79,8 @@
///
FDO_API_COMMON virtual void SetValue(FdoString* value);
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// Constructs a default instance of a FdoDictionaryElement.
FDO_API_COMMON FdoDictionaryElement()
{
@@ -101,6 +101,7 @@
FdoStringP mValue;
};
+/// \ingroup (typedefs)
/// \brief
/// FdoDictionaryElementP is a FdoPtr on FdoDictionaryElement, provided for convenience.
typedef FdoPtr<FdoDictionaryElement> FdoDictionaryElementP;
Modified: trunk/Fdo/Unmanaged/Inc/Common/Dimensionality.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Common/Dimensionality.h 2007-02-15 17:36:56 UTC (rev 2519)
+++ trunk/Fdo/Unmanaged/Inc/Common/Dimensionality.h 2007-02-15 19:23:49 UTC (rev 2520)
@@ -24,6 +24,7 @@
#pragma once
#endif
#ifdef __cplusplus
+ /// \ingroup (enums)
/// \brief
/// FdoDimensionality is an enumeration to describe the presence of spatial dimensions in ordinated data.
///
@@ -31,24 +32,19 @@
/// Values of this enumeration are bit-field definitions.
/// They can be combined via bitwise OR or separated via bitwise AND.
/// \remarks
- /// /// The XY value is zero, thus indicating that all spatial data
+ /// The XY value is zero, thus indicating that all spatial data
/// is assumed to carry X and Y dimensions.
///
- ///
- /// \param FdoDimensionality_XY
- /// X and Y dimensions are present.
- /// \param FdoDimensionality_Z
- /// Z dimension is present.
- /// \param FdoDimensionality_M
- /// M ('measure') dimension is present.
- ///
enum FdoDimensionality
#else
typedef enum
#endif
{
+ /// X and Y dimensions are present.
FdoDimensionality_XY = 0,
+ /// Z dimension is present.
FdoDimensionality_Z = 1,
+ /// M ('measure') dimension is present.
FdoDimensionality_M = 2
#ifdef __cplusplus
};
Modified: trunk/Fdo/Unmanaged/Inc/Common/Disposable.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Common/Disposable.h 2007-02-15 17:36:56 UTC (rev 2519)
+++ trunk/Fdo/Unmanaged/Inc/Common/Disposable.h 2007-02-15 19:23:49 UTC (rev 2520)
@@ -22,7 +22,7 @@
#include <Common/IDisposable.h>
/// \cond DOXYGEN-IGNORE
-/// \brief
+// \brief
/// FdoDisposable is a default implementor for the FdoIDisposable interface.
/// It simply deletes itself
class FdoDisposable : public virtual FdoIDisposable
Modified: trunk/Fdo/Unmanaged/Inc/Common/Exception.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Common/Exception.h 2007-02-15 17:36:56 UTC (rev 2519)
+++ trunk/Fdo/Unmanaged/Inc/Common/Exception.h 2007-02-15 19:23:49 UTC (rev 2520)
@@ -217,8 +217,8 @@
///
FDO_API_COMMON static FdoString* NLSGetMessage(FdoInt32 msgNum, char* defMsg, char* catalog, va_list arguments);
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
wchar_t* m_message;
FdoException* m_cause;
@@ -226,6 +226,9 @@
/// \endcond
};
+
+/// \ingroup (typedefs)
+/// \brief
/// FdoExceptionP is a FdoPtr on FdoException, provided for convenience.
typedef FdoPtr<FdoException> FdoExceptionP;
Modified: trunk/Fdo/Unmanaged/Inc/Common/FdoTypes.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Common/FdoTypes.h 2007-02-15 17:36:56 UTC (rev 2519)
+++ trunk/Fdo/Unmanaged/Inc/Common/FdoTypes.h 2007-02-15 19:23:49 UTC (rev 2520)
@@ -27,19 +27,24 @@
#include <stdint.h>
#endif
+/// \ingroup (typedefs)
/// \brief
/// FdoByte is used to store a single byte of data
typedef unsigned char FdoByte;
#ifdef _WIN32
+/// \ingroup (typedefs)
/// \brief
/// FdoInt8 is used to store a 8 bit signed integer
typedef _int8 FdoInt8;
+/// \ingroup (typedefs)
/// \brief
/// FdoInt16 is used to store a 16 bit signed integer
typedef _int16 FdoInt16;
+/// \ingroup (typedefs)
/// \brief
/// FdoInt32 is used to store a 32 bit signed integer
typedef _int32 FdoInt32;
+/// \ingroup (typedefs)
/// \brief
/// FdoInt64 is used to store a 64 bit signed integer
typedef _int64 FdoInt64;
@@ -51,26 +56,33 @@
typedef int64_t FdoInt64;
/// \endcond
#endif
+/// \ingroup (typedefs)
/// \brief
/// FdoCharacter is used to store a wide character
typedef wchar_t FdoCharacter;
+/// \ingroup (typedefs)
/// \brief
/// FdoString is used to store a constant wide character.
/// Variables declared as FdoString* point to constant wide character strings.
typedef const wchar_t FdoString;
+/// \ingroup (typedefs)
/// \brief
/// FdoBoolean is used to store a boolean (true/false) value
typedef bool FdoBoolean;
+/// \ingroup (typedefs)
/// \brief
/// FdoVoid is used to reference a void (type undetermined)
typedef void FdoVoid;
+/// \ingroup (typedefs)
/// \brief
/// FdoDouble is used to store a double precision floating point number
typedef double FdoDouble;
+/// \ingroup (typedefs)
/// \brief
/// FdoFloat is used to store a single precision floating point number
typedef float FdoFloat;
+/// \ingroup (typedefs)
/// \brief
/// FdoSize is used to store a size value (e.g. number of elements in an array)
typedef size_t FdoSize;
@@ -79,24 +91,14 @@
/// FdoDateTime is used to store dates, times, or both. After constructing
/// the class you determine which portion has been specified. The data members
/// are public so they can be accessed directly. No range checking is performed.
-/// <param name="year">
-/// Year in the range of 1 to 9999
-/// </param>
-/// <param name="month">
-/// Month in the range of 1 to 12 inclusive (January = 1)
-/// </param>
-/// <param name="day">
-/// Day of the month in the range of 1 to 31 inclusive
-/// </param>
-/// <param name="hour">
-/// Hour since midnight in the range of 0 to 23
-/// </param>
-/// <param name="minute">
-/// Minutes after hour in the range of 0 to 59
-/// </param>
-/// <param name="seconds">
-/// Seconds after minute in the range of 0 to 59.9999999
-/// </param>
+/// <ul>
+/// <li>Year is in the range of 1 to 9999</li>
+/// <li>Month is in the range of 1 to 12 inclusive (January = 1)</li>
+/// <li>Day of the month is in the range of 1 to 31 inclusive</li>
+/// <li>Hour is since midnight in the range of 0 to 23</li>
+/// <li>Minutes are after hour in the range of 0 to 59</li>
+/// <li>Seconds are after minute in the range of 0 to 59.9999999</li>
+/// </ul>
class FdoDateTime
{
public:
Modified: trunk/Fdo/Unmanaged/Inc/Common/GeometryType.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Common/GeometryType.h 2007-02-15 17:36:56 UTC (rev 2519)
+++ trunk/Fdo/Unmanaged/Inc/Common/GeometryType.h 2007-02-15 19:23:49 UTC (rev 2520)
@@ -23,64 +23,51 @@
#endif
#ifdef __cplusplus
+/// \ingroup (enums)
/// \brief
/// FdoGeometryType is an enumeration to denote the type of a Geometry.
///
/// \remarks
/// This enumeration applies to types that derive from FdoIGeometry.
- ///
- /// \param FdoGeometryType_None
- /// Indicates no specific type; used for "unknown", "don't care" or an incompletely constructed Geometry object.
- /// \param FdoGeometryType_Point
- /// Point type (FdoIPoint).
- /// \param FdoGeometryType_LineString
- /// LineString type (FdoILineString).
- /// \param FdoGeometryType_Polygon
- /// Polygon type (FdoIPolygon).
- /// \param FdoGeometryType_MultiPoint
- /// MultiPoint type (FdoIMultiPoint).
- /// \param FdoGeometryType_MultiLineString
- /// MultiLineString type (FdoIMultiLineString).
- /// \param FdoGeometryType_MultiPolygon
- /// MultiPolygon type (FdoIMultiPolygon).
- /// \param FdoGeometryType_MultiGeometry
- /// MultiGeometry type (FdoIMultiGeometry).
- /// \param FdoGeometryType_CurveString
- /// CurveString type (FdoICurveString).
- /// \param FdoGeometryType_CurvePolygon
- /// CurvePolygon type (FdoICurvePolygon).
- /// \param FdoGeometryType_MultiCurveString
- /// MultiCurveString type (FdoIMultiCurveString).
- /// \param FdoGeometryType_MultiCurvePolygon
- /// MultiCurvePolygon type (FdoIMultiCurvePolygon).
- ///
enum FdoGeometryType
#else
typedef enum
#endif
{
+ /// Indicates no specific type; used for "unknown", "don't care" or an incompletely constructed Geometry object.
FdoGeometryType_None = 0,
+ /// Point type (FdoIPoint).
FdoGeometryType_Point = 1,
+ /// LineString type (FdoILineString).
FdoGeometryType_LineString = 2,
+ /// Polygon type (FdoIPolygon).
FdoGeometryType_Polygon = 3,
+ /// MultiPoint type (FdoIMultiPoint).
FdoGeometryType_MultiPoint = 4,
+ /// MultiLineString type (FdoIMultiLineString).
FdoGeometryType_MultiLineString = 5,
+ /// MultiPolygon type (FdoIMultiPolygon).
FdoGeometryType_MultiPolygon = 6,
+ /// MultiGeometry type (FdoIMultiGeometry).
FdoGeometryType_MultiGeometry = 7,
+ /// CurveString type (FdoICurveString).
FdoGeometryType_CurveString = 10,
+ /// CurvePolygon type (FdoICurvePolygon).
FdoGeometryType_CurvePolygon = 11,
+ /// MultiCurveString type (FdoIMultiCurveString).
FdoGeometryType_MultiCurveString = 12,
+ /// MultiCurvePolygon type (FdoIMultiCurvePolygon).
FdoGeometryType_MultiCurvePolygon = 13
#ifdef __cplusplus
@@ -91,32 +78,27 @@
#ifdef __cplusplus
+ /// \ingroup (enums)
/// \brief
/// Enumeration for components of Geometry.
///
/// \remarks
/// This enumeration applies to certain helper types that are used to compose other types which derive from FdoIGeometry.
- ///
- /// \param FdoGeometryComponentType_LinearRing
- /// LinearRing type (FdoILinearRing).
- /// \param FdoGeometryComponentType_CircularArcSegment
- /// CircularArcSegment type (FdoICircularArcSegment).
- /// \param FdoGeometryComponentType_LineStringSegment
- /// LineStringSegment type (FdoILineStringSegment).
- /// \param FdoGeometryComponentType_Ring
- /// Ring type (FdoIRing).
- ///
enum FdoGeometryComponentType
#else
typedef enum
#endif
{
+ /// LinearRing type (FdoILinearRing).
FdoGeometryComponentType_LinearRing = 129,
+ /// CircularArcSegment type (FdoICircularArcSegment).
FdoGeometryComponentType_CircularArcSegment = 130,
+ /// LineStringSegment type (FdoILineStringSegment).
FdoGeometryComponentType_LineStringSegment = 131,
+ /// Ring type (FdoIRing).
FdoGeometryComponentType_Ring = 132
#ifdef __cplusplus
Modified: trunk/Fdo/Unmanaged/Inc/Common/IStreamReader.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Common/IStreamReader.h 2007-02-15 17:36:56 UTC (rev 2519)
+++ trunk/Fdo/Unmanaged/Inc/Common/IStreamReader.h 2007-02-15 19:23:49 UTC (rev 2520)
@@ -25,6 +25,7 @@
#include <Common/Std.h>
+/// \ingroup (enums)
/// \brief
/// Enumeration for datatypes used by stream readers.
enum FdoStreamReaderType {
Modified: trunk/Fdo/Unmanaged/Inc/Common/Io/ByteStreamReader.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Common/Io/ByteStreamReader.h 2007-02-15 17:36:56 UTC (rev 2519)
+++ trunk/Fdo/Unmanaged/Inc/Common/Io/ByteStreamReader.h 2007-02-15 19:23:49 UTC (rev 2520)
@@ -57,6 +57,7 @@
};
+/// \ingroup (typedefs)
/// \brief
/// FdoIoByteStreamReaderP is a FdoPtr on FdoIoByteStreamReader, provided for convenience.
typedef FdoPtr<FdoIoByteStreamReader> FdoIoByteStreamReaderP;
Modified: trunk/Fdo/Unmanaged/Inc/Common/Io/FileStream.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Common/Io/FileStream.h 2007-02-15 17:36:56 UTC (rev 2519)
+++ trunk/Fdo/Unmanaged/Inc/Common/Io/FileStream.h 2007-02-15 19:23:49 UTC (rev 2520)
@@ -64,9 +64,9 @@
FDO_API_COMMON virtual FdoBoolean CanRead();
FDO_API_COMMON virtual FdoBoolean CanWrite();
FDO_API_COMMON virtual FdoBoolean HasContext();
-
+
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// Default constructor to satisfy Linux
FdoIoFileStream() {}
FdoIoFileStream(FdoString* fileName, FdoString* accessModes );
@@ -99,6 +99,7 @@
FdoBoolean mbTextMode;
};
+/// \ingroup (typedefs)
/// \brief
/// FdoIoFileStreamP is a FdoPtr on FdoIoFileStream, provided for convenience.
typedef FdoPtr<FdoIoFileStream> FdoIoFileStreamP;
Modified: trunk/Fdo/Unmanaged/Inc/Common/Io/MemoryStream.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Common/Io/MemoryStream.h 2007-02-15 17:36:56 UTC (rev 2519)
+++ trunk/Fdo/Unmanaged/Inc/Common/Io/MemoryStream.h 2007-02-15 19:23:49 UTC (rev 2520)
@@ -92,6 +92,7 @@
};
+/// \ingroup (typedefs)
/// \brief
/// FdoIoMemoryStreamP is a FdoPtr on FdoIoMemoryStream, provided for convenience.
typedef FdoPtr<FdoIoMemoryStream> FdoIoMemoryStreamP;
Modified: trunk/Fdo/Unmanaged/Inc/Common/Io/Stream.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Common/Io/Stream.h 2007-02-15 17:36:56 UTC (rev 2519)
+++ trunk/Fdo/Unmanaged/Inc/Common/Io/Stream.h 2007-02-15 19:23:49 UTC (rev 2520)
@@ -67,7 +67,7 @@
/// reads the number of bytes from the given stream, and writes them
/// to this stream.
///
- /// \param buffer
+ /// \param stream
/// Input write from this buffer
/// \param count
/// Input the maximum number of bytes to read and write.
@@ -83,7 +83,7 @@
/// longer than the current stream length then the stream's length
/// is not changed.
///
- FDO_API_COMMON virtual void SetLength( FdoInt64 ) = 0;
+ FDO_API_COMMON virtual void SetLength( FdoInt64 length) = 0;
/// \brief
/// gets the current length of the stream.
@@ -162,6 +162,7 @@
protected:
};
+/// \ingroup (typedefs)
/// \brief
/// FdoIoStreamP is a FdoPtr on FdoIoStream, provided for convenience.
typedef FdoPtr<FdoIoStream> FdoIoStreamP;
Modified: trunk/Fdo/Unmanaged/Inc/Common/Io/TextReader.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Common/Io/TextReader.h 2007-02-15 17:36:56 UTC (rev 2519)
+++ trunk/Fdo/Unmanaged/Inc/Common/Io/TextReader.h 2007-02-15 19:23:49 UTC (rev 2520)
@@ -74,6 +74,7 @@
FdoIoStreamP mStream;
};
+/// \ingroup (typedefs)
/// \brief
/// FdoIoTextReaderP is a FdoPtr on FdoIoTextReader, provided for convenience.
typedef FdoPtr<FdoIoTextReader> FdoIoTextReaderP;
Modified: trunk/Fdo/Unmanaged/Inc/Common/Io/TextWriter.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Common/Io/TextWriter.h 2007-02-15 17:36:56 UTC (rev 2519)
+++ trunk/Fdo/Unmanaged/Inc/Common/Io/TextWriter.h 2007-02-15 19:23:49 UTC (rev 2520)
@@ -92,6 +92,7 @@
FdoIoStreamP mStream;
};
+/// \ingroup (typedefs)
/// \brief
/// FdoIoTextWriterP is a FdoPtr on FdoIoTextWriter, provided for convenience.
typedef FdoPtr<FdoIoTextWriter> FdoIoTextWriterP;
Modified: trunk/Fdo/Unmanaged/Inc/Common/NamedCollection.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Common/NamedCollection.h 2007-02-15 17:36:56 UTC (rev 2519)
+++ trunk/Fdo/Unmanaged/Inc/Common/NamedCollection.h 2007-02-15 19:23:49 UTC (rev 2520)
@@ -95,31 +95,31 @@
///
virtual OBJ* FindItem(const wchar_t* name) const
{
- /// trigger the building of a map when the collection reaches the threshold size.
+ // trigger the building of a map when the collection reaches the threshold size.
((FdoNamedCollection<OBJ,EXC>*) this)->InitMap();
OBJ* obj = NULL;
if ( mpNameMap ) {
- /// Accessing the map is faster for large collections, so use it if built.
+ // Accessing the map is faster for large collections, so use it if built.
obj = GetMap(name);
- /// If the object name can't be modified then we're done.
- /// Otherwise, there's a chance the object name was modified,
- /// meaning that it can be in the collection but not the map,
- /// or in the wrong place in the map.
+ // If the object name can't be modified then we're done.
+ // Otherwise, there's a chance the object name was modified,
+ // meaning that it can be in the collection but not the map,
+ // or in the wrong place in the map.
if ( (obj != NULL) && !obj->CanSetName() )
return(obj);
- /// If the found object's name is the same as the given name
- /// then we're done. Otherwise, this object's name has changed
- /// and a linear search is needed to find the requested object.
+ // If the found object's name is the same as the given name
+ // then we're done. Otherwise, this object's name has changed
+ // and a linear search is needed to find the requested object.
if ( (obj != NULL) && (Compare(obj->GetName(), name) != 0) )
FDO_SAFE_RELEASE( obj );
}
if ( obj == NULL ) {
- /// No map so do linear search.
+ // No map so do linear search.
for ( FdoInt32 i = 0; i < FdoCollection<OBJ, EXC>::GetCount(); i++ ) {
OBJ* obj = GetItem(i);
@@ -148,15 +148,15 @@
{
CheckDuplicate( value, index );
- /// Remove the old item from the map
+ // Remove the old item from the map
if ( mpNameMap )
RemoveMapAt(index);
- /// Add the new item to the map
+ // Add the new item to the map
if ( mpNameMap && value )
InsertMap( value );
- /// Set the new item in the collection.
+ // Set the new item in the collection.
FdoCollection<OBJ,EXC>::SetItem(index, value);
}
@@ -173,12 +173,12 @@
{
CheckDuplicate( value, -1 );
- /// Insert the new item in the map
+ // Insert the new item in the map
if ( mpNameMap && value ) {
InsertMap(value);
}
- /// add it to the list.
+ // add it to the list.
return( FdoCollection<OBJ,EXC>::Add(value) );
}
@@ -187,8 +187,8 @@
/// Items following the insertion point are moved down to accommodate the new item.
/// Throws an invalid argument exception if the specified index is out of range.
///
- /// \param index
- /// Input index
+ /// \param item
+ /// Input item
/// \param value
/// Input value
///
@@ -199,12 +199,12 @@
{
CheckDuplicate( value, -1 );
- /// Insert the new item in the map
+ // Insert the new item in the map
if ( mpNameMap ) {
InsertMap(value);
}
- /// Insert it in the list
+ // Insert it in the list
return( FdoCollection<OBJ,EXC>::Insert(item, value) );
}
@@ -216,13 +216,13 @@
///
virtual void Clear()
{
- /// Clear the map
+ // Clear the map
if (mpNameMap ) {
delete mpNameMap;
mpNameMap = NULL;
}
- /// Clear the list
+ // Clear the list
FdoCollection<OBJ,EXC>::Clear();
}
@@ -237,11 +237,11 @@
///
virtual void Remove(const OBJ* value)
{
- /// Remove the item from the map.
+ // Remove the item from the map.
if ( mpNameMap )
RemoveMap( value );
- /// Remove it from the list
+ // Remove it from the list
FdoCollection<OBJ,EXC>::Remove(value);
}
@@ -256,11 +256,11 @@
///
virtual void RemoveAt(FdoInt32 index)
{
- /// Remove the item from the map.
+ // Remove the item from the map.
if ( mpNameMap )
RemoveMapAt(index);
- /// Remove it from the list
+ // Remove it from the list
FdoCollection<OBJ,EXC>::RemoveAt(index);
}
@@ -275,12 +275,12 @@
///
virtual bool Contains(const OBJ* value) const
{
- /// trigger the building of a map when the collection reaches the threshold size.
+ // trigger the building of a map when the collection reaches the threshold size.
((FdoNamedCollection<OBJ,EXC>*) this)->InitMap();
if (mpNameMap )
{
- /// If map is built, use it since it is faster.
+ // If map is built, use it since it is faster.
FdoPtr <FdoIDisposable> temp = GetMap (((OBJ*)value)->GetName());
bool ret = (temp != NULL);
return (ret);
@@ -379,7 +379,7 @@
if ( mbCaseSensitive )
return ( wcscmp(str1, str2) );
- /// Try case-insensitive comparison.
+ // Try case-insensitive comparison.
#ifdef _WIN32
return ( _wcsicmp(str1, str2) );
#else
@@ -410,11 +410,11 @@
private:
void InitMap()
{
- /// Build the map if not already built and the collection has hit the threshold
+ // Build the map if not already built and the collection has hit the threshold
if ( !mpNameMap && ( FdoCollection <OBJ, EXC>::GetCount() > FDO_COLL_MAP_THRESHOLD ) ) {
mpNameMap = new std::map<FdoStringP,OBJ*>();
- /// Put all the current elements into the map
+ // Put all the current elements into the map
for ( FdoInt32 i = (FdoCollection <OBJ, EXC>::GetCount() - 1); i >= 0; i-- )
InsertMap( FdoPtr<OBJ>(GetItem(i)) );
}
@@ -422,18 +422,18 @@
void InsertMap( OBJ* value ) const
{
- /// Add an element to the map. Elements are keyed by name, which may or may not be case sensitive.
- /// Case insensitive names are stored in lower case.
+ // Add an element to the map. Elements are keyed by name, which may or may not be case sensitive.
+ // Case insensitive names are stored in lower case.
if ( mbCaseSensitive )
mpNameMap->insert( std::pair<FdoStringP,OBJ*> ( value->GetName(), value ) );
else
mpNameMap->insert( std::pair<FdoStringP,OBJ*> ( FdoStringP(value->GetName()).Lower(), value ) );
}
- /// Remove the element at the specified index, from the map
+ // Remove the element at the specified index, from the map
void RemoveMapAt( FdoInt32 index )
{
- /// Remove the old item from the map
+ // Remove the old item from the map
OBJ* pItem = FdoCollection<OBJ,EXC>::GetItem(index);
if ( pItem ) {
@@ -442,17 +442,17 @@
}
}
- /// Remove the given element from the map.
+ // Remove the given element from the map.
void RemoveMap( const OBJ* value )
{
- /// handle the current case sensitivity of the element name.
+ // handle the current case sensitivity of the element name.
if ( mbCaseSensitive )
mpNameMap->erase( FdoStringP( ((OBJ*)value)->GetName() ) );
else
mpNameMap->erase( FdoStringP( ((OBJ*)value)->GetName() ).Lower() );
}
- /// Get the named element from the map. Returns NULL if element not in map.
+ // Get the named element from the map. Returns NULL if element not in map.
OBJ* GetMap( const wchar_t* name ) const
{
OBJ* pItem = NULL;
@@ -462,7 +462,7 @@
if ( mbCaseSensitive )
iter = mpNameMap->find( FdoStringP(name) );
else
- /// Case sensitive names are stored in lower case.
+ // Case sensitive names are stored in lower case.
iter = mpNameMap->find( FdoStringP(name).Lower() );
if ( iter != mpNameMap->end() ) {
@@ -475,7 +475,7 @@
bool mbCaseSensitive;
- /// A map keyed by name, to help performance of large collections.
+ // A map keyed by name, to help performance of large collections.
std::map<FdoStringP,OBJ*> *mpNameMap;
};
Modified: trunk/Fdo/Unmanaged/Inc/Common/Ptr.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Common/Ptr.h 2007-02-15 17:36:56 UTC (rev 2519)
+++ trunk/Fdo/Unmanaged/Inc/Common/Ptr.h 2007-02-15 19:23:49 UTC (rev 2520)
@@ -215,7 +215,7 @@
/// \brief
/// Less than operator
///
- /// \param lp
+ /// \param pT
/// Input the object to compare
///
/// \return
@@ -230,7 +230,7 @@
/// \brief
/// Equals operator
///
- /// \param lp
+ /// \param pT
/// Input the object to compare
///
/// \return
@@ -300,6 +300,7 @@
}
/// \cond DOXYGEN-IGNORE
+
/// Release the object and set to NULL
void Release() throw()
{
Modified: trunk/Fdo/Unmanaged/Inc/Common/Semaphore.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Common/Semaphore.h 2007-02-15 17:36:56 UTC (rev 2519)
+++ trunk/Fdo/Unmanaged/Inc/Common/Semaphore.h 2007-02-15 19:23:49 UTC (rev 2520)
@@ -20,6 +20,7 @@
//
/// \cond DOXYGEN-IGNORE
+
/// \brief
/// FdoSemaphore is a semaphore class. It is used to prevent operations
/// from happening concurrently or re-entrantly. FdoSemaphore is not currently part
Modified: trunk/Fdo/Unmanaged/Inc/Common/Stack.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Common/Stack.h 2007-02-15 17:36:56 UTC (rev 2519)
+++ trunk/Fdo/Unmanaged/Inc/Common/Stack.h 2007-02-15 19:23:49 UTC (rev 2520)
@@ -24,6 +24,7 @@
#endif
/// \cond DOXYGEN-IGNORE
+
/// \brief
/// FdoStack is an abstract template for a Stack ADT. This class is not yet
/// part of the FDOCommon API. However, doc comments have been added since it might
Modified: trunk/Fdo/Unmanaged/Inc/Common/StringP.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Common/StringP.h 2007-02-15 17:36:56 UTC (rev 2519)
+++ trunk/Fdo/Unmanaged/Inc/Common/StringP.h 2007-02-15 19:23:49 UTC (rev 2520)
@@ -73,7 +73,7 @@
/// \brief
/// Copies a string from a string pointer.
///
- /// \param oValue
+ /// \param oString
/// Source string to copy from.
///
/// \return
@@ -84,7 +84,7 @@
/// \brief
/// Copies a string from a utf8 string.
///
- /// \param sValue
+ /// \param sString
/// Utf8 string to copy from.
///
/// \return
@@ -95,7 +95,7 @@
/// \brief
/// Copies a string from a unicode string.
///
- /// \param sValue
+ /// \param wString
/// Unicode string to copy from.
///
/// \return
@@ -303,7 +303,7 @@
/// \brief
/// Gets the characters to the left of the given sub-string.
///
- /// \param delimeter
+ /// \param delimiter
/// The substring.
///
/// \return
@@ -319,7 +319,7 @@
/// \brief
/// Gets the characters to the right of the given sub-string.
///
- /// \param delimeter
+ /// \param delimiter
/// The substring.
///
/// \return
@@ -441,6 +441,7 @@
FDO_API_COMMON static const wchar_t* mEmptyString;
/// \cond DOXYGEN-IGNORE
+
/// Utility function for converting from unicode to utf8.
/// returned value is allocated and must be deleted by caller.
FDO_API_COMMON static int Utf8FromUnicode(
Modified: trunk/Fdo/Unmanaged/Inc/Common/Vector.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Common/Vector.h 2007-02-15 17:36:56 UTC (rev 2519)
+++ trunk/Fdo/Unmanaged/Inc/Common/Vector.h 2007-02-15 19:23:49 UTC (rev 2520)
@@ -158,7 +158,7 @@
/// \brief
/// Adds a number to the end of this vector.
///
- /// \param src
+ /// \param value
/// Input the source collection
///
FDO_API_COMMON int Add( double value );
@@ -396,8 +396,8 @@
///
FDO_API_COMMON FdoBoolean operator<=( const FdoVectorP vec2 ) const;
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// General function to do the vector comparisons.
FdoBoolean Compare( const FdoVectorP vec2, FdoBoolean lt, FdoBoolean eq, FdoBoolean gt ) const;
/// \endcond
Modified: trunk/Fdo/Unmanaged/Inc/Common/Xml/Attribute.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Common/Xml/Attribute.h 2007-02-15 17:36:56 UTC (rev 2519)
+++ trunk/Fdo/Unmanaged/Inc/Common/Xml/Attribute.h 2007-02-15 19:23:49 UTC (rev 2520)
@@ -181,6 +181,7 @@
FdoStringP mValuePrefix;
};
+/// \ingroup (typedefs)
/// \brief
/// FdoXmlAttributeP is a FdoPtr on FdoXmlAttribute, provided for convenience.
typedef FdoPtr<FdoXmlAttribute> FdoXmlAttributeP;
Modified: trunk/Fdo/Unmanaged/Inc/Common/Xml/AttributeCollection.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Common/Xml/AttributeCollection.h 2007-02-15 17:36:56 UTC (rev 2519)
+++ trunk/Fdo/Unmanaged/Inc/Common/Xml/AttributeCollection.h 2007-02-15 19:23:49 UTC (rev 2520)
@@ -50,6 +50,7 @@
}
};
+/// \ingroup (typedefs)
/// \brief
/// FdoXmlAttributeCollectionP is a FdoPtr on FdoXmlAttributeCollection, provided for convenience.
typedef FdoPtr<FdoXmlAttributeCollection> FdoXmlAttributesP;
Modified: trunk/Fdo/Unmanaged/Inc/Common/Xml/CharDataHandler.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Common/Xml/CharDataHandler.h 2007-02-15 17:36:56 UTC (rev 2519)
+++ trunk/Fdo/Unmanaged/Inc/Common/Xml/CharDataHandler.h 2007-02-15 19:23:49 UTC (rev 2520)
@@ -67,6 +67,7 @@
};
+/// \ingroup (typedefs)
/// \brief
/// FdoXmlCharDataHandlerP is a FdoPtr on FdoXmlCharDataHandler, provided for convenience.
typedef FdoPtr<FdoXmlCharDataHandler> FdoXmlCharDataHandlerP;
Modified: trunk/Fdo/Unmanaged/Inc/Common/Xml/CopyHandler.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Common/Xml/CopyHandler.h 2007-02-15 17:36:56 UTC (rev 2519)
+++ trunk/Fdo/Unmanaged/Inc/Common/Xml/CopyHandler.h 2007-02-15 19:23:49 UTC (rev 2520)
@@ -61,7 +61,7 @@
/// Input current element's Universal Resource Indicator
/// \param name
/// Input the unqualified name of the current element (doesn't include namespace)
- /// \param qname
+ /// \param qName
/// Input the qualified name of the current element(includes namespace)
/// \param atts
/// Input the attributes for the current element.
@@ -88,8 +88,8 @@
return new FdoXmlCopyHandler( writer, uri, name, qName, atts, namespaces );
}
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
FdoXmlCopyHandler() {}
/// \endcond
@@ -147,7 +147,7 @@
/// Input the namespace URI for attribute's containing element.
/// \param name
/// Input the local name for attribute's containing element.
- /// \param qname
+ /// \param qName
/// Input the fully qualified name from attribute's containing element.
/// \param att
/// Input the attribute to check.
@@ -171,7 +171,7 @@
FdoBoolean mWroteCurrElement;
};
-
+/// \ingroup (typedefs)
/// \brief
/// FdoXmlCopyHandlerP is a FdoPtr on FdoXmlCopyHandler, provided for convenience.
typedef FdoPtr<FdoXmlCopyHandler> FdoXmlCopyHandlerP;
Modified: trunk/Fdo/Unmanaged/Inc/Common/Xml/Reader.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Common/Xml/Reader.h 2007-02-15 17:36:56 UTC (rev 2519)
+++ trunk/Fdo/Unmanaged/Inc/Common/Xml/Reader.h 2007-02-15 19:23:49 UTC (rev 2520)
@@ -351,6 +351,7 @@
FdoXmlSaxContextP mSaxContext;
};
+/// \ingroup (typedefs)
/// \brief
/// FdoXmlReaderP is a FdoPtr on FdoXmlReader, provided for convenience.
typedef FdoPtr<FdoXmlReader> FdoXmlReaderP;
Modified: trunk/Fdo/Unmanaged/Inc/Common/Xml/SaxContext.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Common/Xml/SaxContext.h 2007-02-15 17:36:56 UTC (rev 2519)
+++ trunk/Fdo/Unmanaged/Inc/Common/Xml/SaxContext.h 2007-02-15 19:23:49 UTC (rev 2520)
@@ -62,6 +62,7 @@
FdoXmlReader* mpReader;
};
+/// \ingroup (typedefs)
/// \brief
/// FdoXmlSaxContextP is a FdoPtr on FdoXmlSaxContext, provided for convenience.
typedef FdoPtr<FdoXmlSaxContext> FdoXmlSaxContextP;
Modified: trunk/Fdo/Unmanaged/Inc/Common/Xml/SaxHandler.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Common/Xml/SaxHandler.h 2007-02-15 17:36:56 UTC (rev 2519)
+++ trunk/Fdo/Unmanaged/Inc/Common/Xml/SaxHandler.h 2007-02-15 19:23:49 UTC (rev 2520)
@@ -41,7 +41,7 @@
/// Returns the SAX Handler for the document's root element. If NULL then
/// this SAX handler will handle the root element
///
- FDO_API_COMMON virtual FdoXmlSaxHandler* XmlStartDocument(FdoXmlSaxContext*);
+ FDO_API_COMMON virtual FdoXmlSaxHandler* XmlStartDocument(FdoXmlSaxContext* saxContext);
/// \brief
/// Default Sax callback that is called when the FdoXmlReader
@@ -50,7 +50,7 @@
/// \param saxContext
/// Input caller specified contextual information
///
- FDO_API_COMMON virtual void XmlEndDocument(FdoXmlSaxContext*);
+ FDO_API_COMMON virtual void XmlEndDocument(FdoXmlSaxContext* saxContext);
/// \brief
/// Default Sax callback that is called when the FdoXmlReader
@@ -71,7 +71,7 @@
/// Returns the SAX Handler for the element's sub-elements. If NULL then
/// this SAX handler will handle the sub-elements
///
- FDO_API_COMMON virtual FdoXmlSaxHandler* XmlStartElement(FdoXmlSaxContext*, FdoString*, FdoString* name, FdoString*, FdoXmlAttributeCollection*);
+ FDO_API_COMMON virtual FdoXmlSaxHandler* XmlStartElement(FdoXmlSaxContext* saxContext, FdoString* uri, FdoString* name, FdoString* qname, FdoXmlAttributeCollection* atts);
/// \brief
/// Default Sax callback that is called when the FdoXmlReader
@@ -91,7 +91,7 @@
/// cause the parse to continue. Return value is ignored if the current parse
/// is not an incremental parse ( see FdoXmlReader::Parse())
///
- FDO_API_COMMON virtual FdoBoolean XmlEndElement(FdoXmlSaxContext*, FdoString*, FdoString*, FdoString*);
+ FDO_API_COMMON virtual FdoBoolean XmlEndElement(FdoXmlSaxContext* saxContext, FdoString* uri, FdoString* name, FdoString* qname);
/// \brief
/// Default Sax callback that is called when the FdoXmlReader
@@ -105,7 +105,7 @@
/// \param chars
/// Input the next chunk of simple content
///
- FDO_API_COMMON virtual void XmlCharacters(FdoXmlSaxContext*, FdoString*);
+ FDO_API_COMMON virtual void XmlCharacters(FdoXmlSaxContext* saxContext, FdoString* chars);
};
#endif
Modified: trunk/Fdo/Unmanaged/Inc/Common/Xml/SkipElementHandler.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Common/Xml/SkipElementHandler.h 2007-02-15 17:36:56 UTC (rev 2519)
+++ trunk/Fdo/Unmanaged/Inc/Common/Xml/SkipElementHandler.h 2007-02-15 19:23:49 UTC (rev 2520)
@@ -45,14 +45,14 @@
return new FdoXmlSkipElementHandler();
}
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
FdoXmlSkipElementHandler() {}
~FdoXmlSkipElementHandler() {}
/// \endcond
};
-
+/// \ingroup (typedefs)
/// \brief
/// FdoXmlSkipElementHandlerP is a FdoPtr on FdoXmlSkipElementHandler, provided for convenience.
typedef FdoPtr<FdoXmlSkipElementHandler> FdoXmlSkipElementHandlerP;
Modified: trunk/Fdo/Unmanaged/Inc/Common/Xml/Writer.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Common/Xml/Writer.h 2007-02-15 17:36:56 UTC (rev 2519)
+++ trunk/Fdo/Unmanaged/Inc/Common/Xml/Writer.h 2007-02-15 19:23:49 UTC (rev 2520)
@@ -31,28 +31,24 @@
class FdoXmlWriter : public FdoDisposable
{
public:
- /// \brief
- /// FdoXmlWriter::LineFormat specifies whether the output XML document
- /// has line breaks or indentation.
- ///
- /// \param LineFormat_None
- /// The document is written without line breaks or element indentation.
- /// \param LineFormat_Break
- /// The document is written with a line break after:
- /// <ul>
- /// <li> every end element tag
- /// <li> every start tag for elements with complex content (sub-elements)
- /// </ul>
- /// Elements are not indented.
- /// \param LineFormat_Indent
- /// Same as LineFormat_Break, except that each element immediately following
- /// a line break is indented by a certain number of spaces. The number of
- /// spaces is the element's nesting level within the document X 3. The root
- /// element has nesting level 0.
- ///
+
+ /// \brief
+ /// Specifies whether the output XML document
+ /// has line breaks or indentation.
enum LineFormat {
+ /// The document is written without line breaks or element indentation.
LineFormat_None,
+ /// The document is written with a line break after:
+ /// <ul>
+ /// <li>every end element tag</li>
+ /// <li>every start tag for elements with complex content (sub-elements)</li>
+ /// </ul>
+ /// Elements are not indented.
LineFormat_Break,
+ /// Same as LineFormat_Break, except that each element immediately following
+ /// a line break is indented by a certain number of spaces. The number of
+ /// spaces is the element's nesting level within the document X 3. The root
+ /// element has nesting level 0.
LineFormat_Indent
};
@@ -119,7 +115,7 @@
/// \brief
/// Constructs an XML writer on a text writer
///
- /// \param reader
+ /// \param writer
/// Input the text writer.
/// \param defaultRoot
/// true: all elements written are wrapped in a default root element, named "DataStore".
@@ -148,7 +144,7 @@
/// \brief
/// Gets the underlying text writer. If a text writer was passed to this object
- /// then this text writeer is returned.
+ /// then this text writer is returned.
/// Otherwise, an auto-generated text writer is returned (a text writer
/// wrapped around the file name or stream that was passed to this object)
///
@@ -244,10 +240,13 @@
/// Writes arbitrary bytes to the XML Writer. Caller is responsible
/// for ensuring that the text does not introduce any errors into the
/// XML document.
+ ///
+ /// \param bytes
+ /// Input bytes to write.
+ ///
+ /// \param count
+ /// Input count of bytes to write.
///
- /// \param characters
- /// Input characters to write.
- ///
FDO_API_COMMON void WriteBytes( FdoByte* bytes, FdoSize count );
/// \brief
@@ -296,7 +295,7 @@
///
/// \param uri
/// Input the URI corresponding to an element.
- /// \param uri
+ /// \param localName
/// Input the local name corresponding to an element.
/// \param isElement
/// Input a boolean flag indicating that the URI corresponds to an element.
@@ -332,17 +331,17 @@
return mName;
}
- /// returns true if this element declares any namespaces.
+ /// returns true if this element declares any namespaces.
bool GetHasNsDecl();
- /// set an attribute value for this element.
+ /// set an attribute value for this element.
void SetAttribute( FdoString* attributeName, FdoString* attributeValue );
- /// Flush all the attributes to the output document
+ /// Flush all the attributes to the output document
void FlushAttributes( FdoIoTextWriterP pWriter );
- /// Generates fully qualified name for the given element from
- /// namespace declarations in this element.
+ /// Generates fully qualified name for the given element from
+ /// namespace declarations in this element.
FdoStringP UriToQName( FdoString* uri, FdoString* localName, FdoBoolean isElement );
static FdoStringP EncodeValue ( FdoStringP value );
@@ -368,8 +367,8 @@
public:
static ElementStack* Create() {return new ElementStack();}
- /// Generates fully qualified name for the given element or attribute from
- /// namespace declarations in the stacked elements.
+ /// Generates fully qualified name for the given element or attribute from
+ /// namespace declarations in the stacked elements.
FdoStringP UriToQName( FdoString* uri, FdoString* localName, FdoBoolean isElement );
protected:
@@ -417,6 +416,7 @@
FdoSize mCharWritten;
};
+/// \ingroup (typedefs)
/// \brief
/// FdoXmlWriterP is a FdoPtr on FdoXmlWriter, provided for convenience.
typedef FdoPtr<FdoXmlWriter> FdoXmlWriterP;
Modified: trunk/Fdo/Unmanaged/Inc/Common/Xml/XmlException.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Common/Xml/XmlException.h 2007-02-15 17:36:56 UTC (rev 2519)
+++ trunk/Fdo/Unmanaged/Inc/Common/Xml/XmlException.h 2007-02-15 19:23:49 UTC (rev 2520)
@@ -30,8 +30,8 @@
/// FDO XML package
class FdoXmlException : public FdoException
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// \brief
/// Constructs a default instance of an FdoXmlException.
///
@@ -95,6 +95,7 @@
};
+/// \ingroup (typedefs)
/// \brief
/// FdoXmlExceptionP is a FdoPtr on FdoXmlException, provided for convenience.
typedef FdoPtr<FdoXmlException> FdoXmlExceptionP;
Modified: trunk/Fdo/Unmanaged/Inc/Common/Xsl/Transformer.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Common/Xsl/Transformer.h 2007-02-15 17:36:56 UTC (rev 2519)
+++ trunk/Fdo/Unmanaged/Inc/Common/Xsl/Transformer.h 2007-02-15 19:23:49 UTC (rev 2520)
@@ -140,8 +140,8 @@
///
FDO_API_COMMON virtual void Transform() = 0;
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
FdoXslTransformer(
FdoXmlReader* inDoc = NULL,
FdoXmlReader* stylesheet = NULL,
@@ -165,6 +165,7 @@
FdoIoTextWriterP mLog;
};
+/// \ingroup (typedefs)
/// \brief
/// FdoXslTransformerP is a FdoPtr on FdoXslTransformer, provided for convenience.
typedef FdoPtr<FdoXslTransformer> FdoXslTransformerP;
More information about the fdo-commits
mailing list