AnotherFoxGuy/polyvox
1
0
Fork 0
Code Issues Pull Requests Activity

Add some \deprecated Doxygen commands to deprecated functions

Browse Source
This commit is contained in:
Matt Williams 2012-10-28 20:20:39 +00:00
parent cc714af44c
commit 17c31b2ca1
2 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
library/PolyVoxCore/source/Region.cpp
View File

@ -168,6 +168,7 @@ namespace PolyVox
m_v3dUpperCorner.setZ((std::min)(m_v3dUpperCorner.getZ(), other.m_v3dUpperCorner.getZ())); m_v3dUpperCorner.setZ((std::min)(m_v3dUpperCorner.getZ(), other.m_v3dUpperCorner.getZ()));
} }
/// \deprecated Use getLowerCorner and getUpperCorner instead
int32_t Region::depth(void) const int32_t Region::depth(void) const
{ {
//This function is deprecated and wrong. //This function is deprecated and wrong.
@ -175,6 +176,7 @@ namespace PolyVox
return m_v3dUpperCorner.getZ() - m_v3dLowerCorner.getZ(); return m_v3dUpperCorner.getZ() - m_v3dLowerCorner.getZ();
} }
/// \deprecated Use getLowerCorner and getUpperCorner instead
int32_t Region::height(void) const int32_t Region::height(void) const
{ {
//This function is deprecated and wrong. //This function is deprecated and wrong.
@ -198,6 +200,7 @@ namespace PolyVox
m_v3dUpperCorner += amount; m_v3dUpperCorner += amount;
} }
/// \deprecated Use getLowerCorner and getUpperCorner instead
Vector3DInt32 Region::dimensions(void) Vector3DInt32 Region::dimensions(void)
{ {
//This function is deprecated and wrong. //This function is deprecated and wrong.
@ -205,6 +208,7 @@ namespace PolyVox
return m_v3dUpperCorner - m_v3dLowerCorner; return m_v3dUpperCorner - m_v3dLowerCorner;
} }
/// \deprecated Use getLowerCorner and getUpperCorner instead
int32_t Region::width(void) const int32_t Region::width(void) const
{ {
//This function is deprecated and wrong. //This function is deprecated and wrong.

4
library/PolyVoxUtil/include/PolyVoxUtil/Serialization.h
View File

@ -42,13 +42,17 @@ namespace PolyVox
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
// THESE FUNCTIONS ARE DEPRECATED. USE VERSIONED 'loadVolume' AND 'saveVolume' INSTEAD. // THESE FUNCTIONS ARE DEPRECATED. USE VERSIONED 'loadVolume' AND 'saveVolume' INSTEAD.
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// \deprecated Use versioned loadVolume instead
template< typename VolumeType > template< typename VolumeType >
polyvox_shared_ptr< VolumeType > loadVolumeRaw(std::istream& stream, VolumeSerializationProgressListener* progressListener = 0); polyvox_shared_ptr< VolumeType > loadVolumeRaw(std::istream& stream, VolumeSerializationProgressListener* progressListener = 0);
/// \deprecated Use versioned saveVolume instead
template< typename VolumeType > template< typename VolumeType >
void saveVolumeRaw(std::ostream& stream, VolumeType& volume, VolumeSerializationProgressListener* progressListener = 0); void saveVolumeRaw(std::ostream& stream, VolumeType& volume, VolumeSerializationProgressListener* progressListener = 0);
/// \deprecated Use versioned loadVolume instead
template< typename VolumeType > template< typename VolumeType >
polyvox_shared_ptr< VolumeType > loadVolumeRle(std::istream& stream, VolumeSerializationProgressListener* progressListener = 0); polyvox_shared_ptr< VolumeType > loadVolumeRle(std::istream& stream, VolumeSerializationProgressListener* progressListener = 0);
/// \deprecated Use versioned saveVolume instead
template< typename VolumeType > template< typename VolumeType >
void saveVolumeRle(std::ostream& stream, VolumeType& volume, VolumeSerializationProgressListener* progressListener = 0); void saveVolumeRle(std::ostream& stream, VolumeType& volume, VolumeSerializationProgressListener* progressListener = 0);