From 17c31b2ca12379160b3e6522cbfe1aac1e958d92 Mon Sep 17 00:00:00 2001 From: Matt Williams Date: Sun, 28 Oct 2012 20:20:39 +0000 Subject: [PATCH] Add some \deprecated Doxygen commands to deprecated functions --- library/PolyVoxCore/source/Region.cpp | 4 ++++ library/PolyVoxUtil/include/PolyVoxUtil/Serialization.h | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/library/PolyVoxCore/source/Region.cpp b/library/PolyVoxCore/source/Region.cpp index 436265b0..79040009 100644 --- a/library/PolyVoxCore/source/Region.cpp +++ b/library/PolyVoxCore/source/Region.cpp @@ -168,6 +168,7 @@ namespace PolyVox m_v3dUpperCorner.setZ((std::min)(m_v3dUpperCorner.getZ(), other.m_v3dUpperCorner.getZ())); } + /// \deprecated Use getLowerCorner and getUpperCorner instead int32_t Region::depth(void) const { //This function is deprecated and wrong. @@ -175,6 +176,7 @@ namespace PolyVox return m_v3dUpperCorner.getZ() - m_v3dLowerCorner.getZ(); } + /// \deprecated Use getLowerCorner and getUpperCorner instead int32_t Region::height(void) const { //This function is deprecated and wrong. @@ -198,6 +200,7 @@ namespace PolyVox m_v3dUpperCorner += amount; } + /// \deprecated Use getLowerCorner and getUpperCorner instead Vector3DInt32 Region::dimensions(void) { //This function is deprecated and wrong. @@ -205,6 +208,7 @@ namespace PolyVox return m_v3dUpperCorner - m_v3dLowerCorner; } + /// \deprecated Use getLowerCorner and getUpperCorner instead int32_t Region::width(void) const { //This function is deprecated and wrong. diff --git a/library/PolyVoxUtil/include/PolyVoxUtil/Serialization.h b/library/PolyVoxUtil/include/PolyVoxUtil/Serialization.h index 25afe118..540cc0b1 100644 --- a/library/PolyVoxUtil/include/PolyVoxUtil/Serialization.h +++ b/library/PolyVoxUtil/include/PolyVoxUtil/Serialization.h @@ -42,13 +42,17 @@ namespace PolyVox //////////////////////////////////////////////////////////////////////////////// // THESE FUNCTIONS ARE DEPRECATED. USE VERSIONED 'loadVolume' AND 'saveVolume' INSTEAD. //////////////////////////////////////////////////////////////////////////////// + /// \deprecated Use versioned loadVolume instead template< typename VolumeType > polyvox_shared_ptr< VolumeType > loadVolumeRaw(std::istream& stream, VolumeSerializationProgressListener* progressListener = 0); + /// \deprecated Use versioned saveVolume instead template< typename VolumeType > void saveVolumeRaw(std::ostream& stream, VolumeType& volume, VolumeSerializationProgressListener* progressListener = 0); + /// \deprecated Use versioned loadVolume instead template< typename VolumeType > polyvox_shared_ptr< VolumeType > loadVolumeRle(std::istream& stream, VolumeSerializationProgressListener* progressListener = 0); + /// \deprecated Use versioned saveVolume instead template< typename VolumeType > void saveVolumeRle(std::ostream& stream, VolumeType& volume, VolumeSerializationProgressListener* progressListener = 0);