[fdo-commits] r2600 - in trunk/Providers/SDF: Docs/doc_src Inc/SDF
svn_fdo at osgeo.org
svn_fdo at osgeo.org
Thu Feb 22 17:09:03 EST 2007
Author: gregboone
Date: 2007-02-22 17:09:03 -0500 (Thu, 22 Feb 2007)
New Revision: 2600
Modified:
trunk/Providers/SDF/Docs/doc_src/Doxyfile_SDF
trunk/Providers/SDF/Inc/SDF/ICreateSDFFile.h
trunk/Providers/SDF/Inc/SDF/IExtendedSelect.h
trunk/Providers/SDF/Inc/SDF/IScrollableFeatureReader.h
trunk/Providers/SDF/Inc/SDF/SdfCompareHandler.h
Log:
Ticket #4: Update API documentation generation process
Modified: trunk/Providers/SDF/Docs/doc_src/Doxyfile_SDF
===================================================================
--- trunk/Providers/SDF/Docs/doc_src/Doxyfile_SDF 2007-02-22 22:00:16 UTC (rev 2599)
+++ trunk/Providers/SDF/Docs/doc_src/Doxyfile_SDF 2007-02-22 22:09:03 UTC (rev 2600)
@@ -1,4 +1,4 @@
-# Doxyfile 1.4.6
+# Doxyfile 1.5.1
#---------------------------------------------------------------------------
# Project related configuration options
@@ -107,7 +107,7 @@
#---------------------------------------------------------------------------
GENERATE_HTML = YES
HTML_OUTPUT = ../HTML/SDF
-HTML_FILE_EXTENSION = .html
+HTML_FILE_EXTENSION = .htm
HTML_HEADER = headers_and_footers/header.html
HTML_FOOTER = headers_and_footers/footer.html
HTML_STYLESHEET = headers_and_footers/custom.css
Modified: trunk/Providers/SDF/Inc/SDF/ICreateSDFFile.h
===================================================================
--- trunk/Providers/SDF/Inc/SDF/ICreateSDFFile.h 2007-02-22 22:00:16 UTC (rev 2599)
+++ trunk/Providers/SDF/Inc/SDF/ICreateSDFFile.h 2007-02-22 22:09:03 UTC (rev 2600)
@@ -33,10 +33,6 @@
///
/// \param name
/// The fully qualified SDF+ file name.
- ///
- /// \return
- /// Returns nothing.
- ///
FDO_API virtual void SetFileName(FdoString* name) = 0;
/// \brief
@@ -53,10 +49,6 @@
///
/// \param name
/// Input the name of the spatial context.
- ///
- /// \return
- /// Returns nothing.
- ///
FDO_API virtual void SetSpatialContextName(FdoString* name) = 0;
/// \brief
@@ -74,10 +66,6 @@
///
/// \param description
/// Input the description of the spatial context.
- ///
- /// \return
- /// Returns nothing.
- ///
FDO_API virtual void SetSpatialContextDescription(FdoString* description) = 0;
/// \brief
@@ -94,10 +82,6 @@
///
/// \param wkt
/// Input the coordinate system.
- ///
- /// \return
- /// Returns nothing.
- ///
FDO_API virtual void SetCoordinateSystemWKT(FdoString* wkt) = 0;
/// \brief
@@ -119,14 +103,12 @@
///
/// \param tolerance
/// Input the tolerance.
- ///
- /// \return
- /// Returns nothing.
- ///
FDO_API virtual void SetXYTolerance(double tolerance) = 0;
/// \brief
/// Gets the tolerance value for X/Y ordinates of the spatial context.
+ ///
+ /// \remarks
/// Tolerances are used in some geometric tests,
/// mostly for equality between coordinates. This occurs frequently in spatial
/// queries, especially with "on boundary" or "just touching" conditions.
@@ -139,7 +121,10 @@
FDO_API virtual double GetXYTolerance() = 0;
/// \brief
- /// Sets the tolerance value to use for Z ordinates. Tolerances are used in
+ /// Sets the tolerance value to use for Z ordinates.
+ ///
+ /// \remarks
+ /// Tolerances are used in
/// some geometric tests, mostly for equality between coordinates. This
/// occurs frequently in spatial queries, especially with "on boundary" or "just
/// touching" conditions. It is also an objective amount that can be used
@@ -147,14 +132,12 @@
///
/// \param tolerance
/// Input the tolerance.
- ///
- /// \return
- /// Returns nothing.
- ///
FDO_API virtual void SetZTolerance(double tolerance) = 0;
/// \brief
/// Gets the tolerance value for Z ordinates of the spatial context.
+ ///
+ /// \remarks
/// Tolerances are used in some geometric tests,
/// mostly for equality between coordinates. This occurs a frequently in spatial
/// queries, especially with "on boundary" or "just touching" conditions.
@@ -169,10 +152,6 @@
/// \brief
/// Executes the command. An exception is thrown if the file fails to be
/// created.
- ///
- /// \return
- /// Returns nothing.
- ///
FDO_API virtual void Execute() = 0;
};
Modified: trunk/Providers/SDF/Inc/SDF/IExtendedSelect.h
===================================================================
--- trunk/Providers/SDF/Inc/SDF/IExtendedSelect.h 2007-02-22 22:00:16 UTC (rev 2599)
+++ trunk/Providers/SDF/Inc/SDF/IExtendedSelect.h 2007-02-22 22:09:03 UTC (rev 2600)
@@ -30,44 +30,77 @@
using FdoISelect::GetOrderingOption;
using FdoISelect::SetOrderingOption;
- /// <summary>Set the ordering option of the selection. This is only used if the ordering collection is not empty.</summary>
- /// <param name="propertyName">Is the property name for which the ordering should be applied. This property should be in the ordering collection.</param>
- /// <param name="option">Is the ordering option and should be set to one of FdoOrderingOption_Ascending or FdoOrderingOption_Descending.
- /// FdoOrderingOption_Ascending is the default value.</param>
- /// <returns>Returns nothing</returns>
+ /// \brief
+ /// Set the ordering option of the selection.
+ ///
+ /// \remarks
+ /// This is only used if the ordering collection is not empty.
+ ///
+ /// \param propertyName
+ /// Is the property name for which the ordering should be applied. This property should be in the ordering collection.
+ ///
+ /// \param option
+ /// Is the ordering option and should be set to one of FdoOrderingOption_Ascending or FdoOrderingOption_Descending.
+ /// FdoOrderingOption_Ascending is the default value.
virtual void SetOrderingOption( FdoString* propertyName, FdoOrderingOption option ) = 0;
- /// <summary>Gets the ordering option for a given property.</summary>
- /// <param name="propertyName">Is the property name for which the ordering should be applied. This property should be in the ordering collection.</param>
- /// <returns>Returns the ordering option.</returns>
+ /// \brief
+ /// Gets the ordering option for a given property.
+ ///
+ /// \param propertyName
+ //Is the property name for which the ordering should be applied. This property should be in the ordering collection.
+ ///
+ /// \return
+ /// Returns the ordering option.
virtual FdoOrderingOption GetOrderingOption( FdoString* propertyName ) = 0;
- /// <summary>This method clears the internal list of property/ordering option list and re-sets the ordering option for all
+ /// \brief
+ /// Clears the internal list of property/ordering option list and re-sets the ordering option for all
/// the ordering properties to the default FdoOrderingOption_Ascending or to the ordering option specified by the
- /// FdoIBaseSelect interface.</summary>
- /// <returns>Returns nothing.</returns>
+ /// FdoIBaseSelect interface.
virtual void ClearOrderingOptions( ) = 0;
- /// <summary>Set the compare handler. This method is used to override the default sdf compare handler.</summary>
- /// <param name="handler">The compare handle that should be derived from the SdfCompareHandler class.</param>
- /// <returns>Returns nothing</returns>
+ /// \brief
+ /// Sets the compare handler.
+ ///
+ /// \remarks
+ /// This method is used to override the default sdf compare handler.
+ ///
+ /// \param handler
+ /// The compare handle that should be derived from the SdfCompareHandler class.
virtual void SetCompareHandler( SdfCompareHandler* handler ) = 0;
- /// <summary> Executes the select command and returns a SdfIScrollableFeatureReader.
+ /// \brief
+ /// Executes the select command and returns an SdfIScrollableFeatureReader.
+ ///
+ /// \remarks
/// If ordering is enabled, then the returned reader is sorted according to
- /// the ordering collection. This method perform sorting in memory and allocates an integer value for each row.</summary>
- /// <returns>Returns a SdfIScrollableFeatureReader object</returns>
+ /// the ordering collection. This method perform sorting in memory and allocates an integer value for each row.
+ /// \return
+ /// Returns a SdfIScrollableFeatureReader object
virtual SdfIScrollableFeatureReader* ExecuteScrollable() = 0;
- /// <summary> Executes the select command and returns a SdfIScrollableFeatureReader. This method creates a temporary SDF file
- /// that contains the selected properties. If ordering is enabled, then the created temporary SDF file is sorted according to
- /// the ordering collection. In this case the sorting is file based where the SQLite BTree is used.
+ /// \brief
+ /// Executes the select command and returns a SdfIScrollableFeatureReader.
+ /// \remarks
+ /// Creates a temporary SDF file that contains the selected properties.
+ /// If ordering is enabled, then the created temporary SDF file
+ /// is sorted according to the ordering collection.
+ /// In this case the sorting is file based where the SQLite BTree is used.
// The extendedProps and extendedDefaults can be used to extend the class definition of the selected data.
- /// Both collections have to be in-sync otherwise an exception will be thrown.</summary>
- /// <param name="sdfCacheFile">File path and name used to store the result of the query.</param>
- /// <param name="extendedProps">A collection of data property definition that extends the class definition defined by the selected properties.</param>
- /// <param name="extendedDefaults">A collection of property values used as defaults for extended properties defined by extendedProps parameter.</param>
- /// <returns>Returns a SdfIScrollableFeatureReader object</returns>
+ /// Both collections have to be in-sync otherwise an exception will be thrown.
+ ///
+ /// \param sdfCacheFile
+ /// File path and name used to store the result of the query.
+ ///
+ /// \param extendedProps
+ /// A collection of data property definition that extends the class definition defined by the selected properties.
+ ///
+ /// \param extendedDefaults
+ /// A collection of property values used as defaults for extended properties defined by extendedProps parameter.
+ ///
+ /// \return
+ /// Returns a SdfIScrollableFeatureReader object.
virtual SdfIScrollableFeatureReader* ExecuteScrollable( const wchar_t* sdfCacheFile, FdoDataPropertyDefinitionCollection* extendedProps, FdoPropertyValueCollection* extendedDefaults ) = 0;
};
Modified: trunk/Providers/SDF/Inc/SDF/IScrollableFeatureReader.h
===================================================================
--- trunk/Providers/SDF/Inc/SDF/IScrollableFeatureReader.h 2007-02-22 22:00:16 UTC (rev 2599)
+++ trunk/Providers/SDF/Inc/SDF/IScrollableFeatureReader.h 2007-02-22 22:09:03 UTC (rev 2600)
@@ -23,44 +23,85 @@
{
public:
- /// <summary>Returns the number of records of the query result.</summary>
- /// <returns>Returns number of records.</returns>
+ /// \brief
+ /// Returns the number of records of the query result.
+ ///
+ /// \return
+ /// Returns number of records.
virtual int Count() = 0;
- /// <summary>Position the reader at the first record of the query result. This method returns false if the query result is empty.</summary>
- /// <returns>Returns true if a record is found or false if the result is empty.</returns>
+ /// \brief
+ /// Positions the reader at the first record of the query result.
+ ///
+ /// \return
+ /// Returns true if a record is found or false if the result is empty.
virtual bool ReadFirst() = 0;
- /// <summary>Position the reader at the last record of the query result. This method returns false if the query result is empty.</summary>
- /// <returns>Returns true if a record is found or false if the result is empty.</returns>
+ /// \brief
+ /// Position the reader at the last record of the query result.
+ ///
+ /// \return
+ /// Returns true if a record is found or false if the result is empty.
virtual bool ReadLast() = 0;
- /// <summary>Advances the reader to the previous item and returns true if there is
- /// another object to read or false if reading is complete. The default
- /// position of the reader is prior to the first item. Therefore you
- /// must call ReadFirst or ReadLast to begin accessing any data.</summary>
- /// <returns>Returns true if a record is found or false otherwise.</returns>
+ /// \brief
+ /// Advances the reader to the previous item.
+ ///
+ /// \remarks
+ /// The default position of the reader is prior to the first item.
+ /// Therefore you must call ReadFirst or ReadLast to
+ /// begin accessing any data.
+ ///
+ /// \return
+ /// Returns true if a record is found or false if reading is complete.
virtual bool ReadPrevious() = 0;
- /// <summary>provide the ad-hoc access to the query result. It positions the position of the reader at a given record
- /// defined by the key. If the record is not found, then the reader position is unset and false value is returned.
- /// Once the reader’s position becames unset, the caller needs to call ReadFirst, ReadLast or ReadAt to re-position
- /// the reader at a valid location.</returns>
- /// <param name="key">The key that identifies a record.</param>
- /// <returns>Returns true if a record is found or false otherwise.</returns>
+ /// \brief
+ /// Provides the ad-hoc access to the query result.
+ ///
+ /// \remarks
+ /// It positions the position of the reader at a given record
+ /// defined by the key. If the record is not found,
+ /// then the reader position is unset and false value is returned.
+ /// Once the reader’s position becames unset,
+ /// the caller needs to call ReadFirst, ReadLast or ReadAt to re-position
+ /// the reader at a valid location.
+ ///
+ /// \param key
+ /// The key that identifies a record.
+ ///
+ /// \return
+ /// Returns true if a record is found or false otherwise.
virtual bool ReadAt(FdoPropertyValueCollection* key) = 0;
- /// <summary>Provides an ad-hoc access to the query result. The recordindex is the one-based nth item in the query result.
- /// If successful, this method will position the reader at the feature identified by the recordindex.</summary>
- /// <param name="recordindex">The index of the row.</param>
- /// <returns>Returns true if a record is found or false otherwise.</returns>
+ /// \brief
+ /// Provides an ad-hoc access to the query result.
+ ///
+ /// \remarks
+ /// The recordindex is the one-based nth item in the query result.
+ /// If successful, this method will position the reader at the feature identified by the recordindex.
+ ///
+ /// \param recordindex
+ /// The index of the row.
+ ///
+ /// \return
+ /// Returns true if a record is found or false otherwise.
virtual bool ReadAtIndex( unsigned int recordindex ) = 0;
- /// <summary>Given a key of a feature, IndexOf will return the one based index or the record number of the feature within
- /// the returned query result. If the record is not found, then zero is retuned. This is the mirror function of the GetAtIndex function. This method does not affect the reader position.
- /// GetAtIndex need to be called to move the reader to the returned index.</summary>
- /// <param name="key">The key that identifies a record.</param>
- /// <returns>Returns true if a record is found or false otherwise.</returns>
+ /// \brief
+ /// Given a key of a feature, IndexOf will return the one based index or the record number of the feature within
+ /// the returned query result.
+ /// \remarks
+ /// If the record is not found, then zero is retuned.
+ /// This is the mirror function of the GetAtIndex function.
+ /// This method does not affect the reader position.
+ /// GetAtIndex need to be called to move the reader to the returned index.
+ ///
+ /// \param key
+ /// The key that identifies a record.
+ ///
+ /// \return
+ /// Returns true if a record is found or false otherwise.
virtual unsigned int IndexOf(FdoPropertyValueCollection* key) = 0;
};
Modified: trunk/Providers/SDF/Inc/SDF/SdfCompareHandler.h
===================================================================
--- trunk/Providers/SDF/Inc/SDF/SdfCompareHandler.h 2007-02-22 22:00:16 UTC (rev 2599)
+++ trunk/Providers/SDF/Inc/SDF/SdfCompareHandler.h 2007-02-22 22:09:03 UTC (rev 2600)
@@ -38,64 +38,131 @@
SDF_API virtual void Dispose() { delete this; }
public:
- /// <summary>The factory function that can be used to create new instance of this class.</summary>
- /// <returns>Returns a new instance of theSdfCompareHandler class.</returns>
+ /// \brief
+ /// The factory function that can be used to create new instance of this class.
+ ///
+ /// \return
+ /// Returns a new instance of theSdfCompareHandler class.
SDF_API static SdfCompareHandler* Create();
- /// <summary>Compares double values.</summary>
- /// <param name="name">Is the property name.</param>
- /// <param name="val1">Is the value of the first object.</param>
- /// <param name="val1">Is the value of the second object.</param>
- /// <returns>Returns a positive value if val1 is greater than val2, negative if val1 is smaller than val2 or zero if both val1 and val2 are equal.</returns>
+ /// \brief
+ /// Compares double values.
+ ///
+ /// \param name
+ /// Is the property name.</param>
+ //
+ /// \param val1
+ /// Is the value of the first object.
+ /// \param val2
+ /// Is the value of the second object.
+ ///
+ /// \return
+ /// Returns a positive value if val1 is greater than val2, negative if val1 is smaller than val2 or zero if both val1 and val2 are equal.
SDF_API virtual int Compare( const wchar_t* name, double val1, double val2 );
- /// <summary>Compares float values.</summary>
- /// <param name="name">Is the property name.</param>
- /// <param name="val1">Is the value of the first object.</param>
- /// <param name="val1">Is the value of the second object.</param>
- /// <returns>Returns a positive value if val1 is greater than val2, negative if val1 is smaller than val2 or zero if both val1 and val2 are equal.</returns>
+ /// \brief
+ /// Compares float values.
+ ///
+ /// \param name
+ /// Is the property name.</param>
+ //
+ /// \param val1
+ /// Is the value of the first object.
+ /// \param val2
+ /// Is the value of the second object.
+ ///
+ /// \return
+ /// Returns a positive value if val1 is greater than val2, negative if val1 is smaller than val2 or zero if both val1 and val2 are equal.
SDF_API virtual int Compare( const wchar_t* name, float val1, float val2 );
- /// <summary>Compares int64 values.</summary>
- /// <param name="name">Is the property name.</param>
- /// <param name="val1">Is the value of the first object.</param>
- /// <param name="val1">Is the value of the second object.</param>
- /// <returns>Returns a positive value if val1 is greater than val2, negative if val1 is smaller than val2 or zero if both val1 and val2 are equal.</returns>
+ /// \brief
+ /// Compares int64 values.
+ ///
+ /// \param name
+ /// Is the property name.</param>
+ //
+ /// \param val1
+ /// Is the value of the first object.
+ /// \param val2
+ /// Is the value of the second object.
+ ///
+ /// \return
+ /// Returns a positive value if val1 is greater than val2, negative if val1 is smaller than val2 or zero if both val1 and val2 are equal.
SDF_API virtual int Compare( const wchar_t* name, FdoInt64 val1, FdoInt64 val2 );
- /// <summary>Compares int32 values.</summary>
- /// <param name="name">Is the property name.</param>
- /// <param name="val1">Is the value of the first object.</param>
- /// <param name="val1">Is the value of the second object.</param>
- /// <returns>Returns a positive value if val1 is greater than val2, negative if val1 is smaller than val2 or zero if both val1 and val2 are equal.</returns>
+ /// \brief
+ /// Compares int32 values.
+ ///
+ /// \param name
+ /// Is the property name.</param>
+ //
+ /// \param val1
+ /// Is the value of the first object.
+ /// \param val2
+ /// Is the value of the second object.
+ ///
+ /// \return
+ /// Returns a positive value if val1 is greater than val2, negative if val1 is smaller than val2 or zero if both val1 and val2 are equal.
SDF_API virtual int Compare( const wchar_t* name, FdoInt32 val1, FdoInt32 val2 );
- /// <summary>Compares int16 values.</summary>
- /// <param name="name">Is the property name.</param>
- /// <param name="val1">Is the value of the first object.</param>
- /// <param name="val1">Is the value of the second object.</param>
- /// <returns>Returns a positive value if val1 is greater than val2, negative if val1 is smaller than val2 or zero if both val1 and val2 are equal.</returns>
+ /// \brief
+ /// Compares int16 values.
+ ///
+ /// \param name
+ /// Is the property name.</param>
+ //
+ /// \param val1
+ /// Is the value of the first object.
+ /// \param val2
+ /// Is the value of the second object.
+ ///
+ /// \return
+ /// Returns a positive value if val1 is greater than val2, negative if val1 is smaller than val2 or zero if both val1 and val2 are equal.
SDF_API virtual int Compare( const wchar_t* name, FdoInt16 val1, FdoInt16 val2 );
- /// <summary>Compares string values.</summary>
- /// <param name="name">Is the property name.</param>
- /// <param name="val1">Is the value of the first object.</param>
- /// <param name="val1">Is the value of the second object.</param>
- /// <returns>Returns a positive value if val1 is greater than val2, negative if val1 is smaller than val2 or zero if both val1 and val2 are equal.</returns>
+ /// \brief
+ /// Compares string values.
+ ///
+ /// \param name
+ /// Is the property name.</param>
+ //
+ /// \param val1
+ /// Is the value of the first object.
+ /// \param val2
+ /// Is the value of the second object.
+ ///
+ /// \return
+ /// Returns a positive value if val1 is greater than val2, negative if val1 is smaller than val2 or zero if both val1 and val2 are equal.
SDF_API virtual int Compare( const wchar_t* name, const wchar_t* val1, const wchar_t* val2 );
- /// <summary>Compares date time values.</summary>
- /// <param name="name">Is the property name.</param>
- /// <param name="val1">Is the value of the first object.</param>
- /// <param name="val1">Is the value of the second object.</param>
- /// <returns>Returns a positive value if val1 is greater than val2, negative if val1 is smaller than val2 or zero if both val1 and val2 are equal.</returns>
+ /// \brief
+ /// Compares date time values.
+ ///
+ /// \param name
+ /// Is the property name.</param>
+ //
+ /// \param val1
+ /// Is the value of the first object.
+ /// \param val2
+ /// Is the value of the second object.
+ ///
+ /// \return
+ /// Returns a positive value if val1 is greater than val2, negative if val1 is smaller than val2 or zero if both val1 and val2 are equal.
SDF_API virtual int Compare( const wchar_t* name, FdoDateTime val1, FdoDateTime val2 );
- /// <summary>Compares unsigned char values.</summary>
- /// <param name="name">Is the property name.</param>
- /// <param name="val1">Is the value of the first object.</param>
- /// <param name="val1">Is the value of the second object.</param>
- /// <returns>Returns a positive value if val1 is greater than val2, negative if val1 is smaller than val2 or zero if both val1 and val2 are equal.</returns>
+ /// \brief
+ /// Compares unsigned char values.
+ ///
+ /// \param name
+ /// Is the property name.</param>
+ //
+ /// \param val1
+ /// Is the value of the first object.
+ /// \param val2
+ /// Is the value of the second object.
+ ///
+ /// \return
+ /// Returns a positive value if val1 is greater than val2, negative if val1 is smaller than val2 or zero if both val1 and val2 are equal.
SDF_API virtual int Compare( const wchar_t* name, unsigned char val1, unsigned char val2 );
};
More information about the fdo-commits
mailing list