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

Add some [out] parameter documentation

Browse Source
This commit is contained in:
Matt Williams 2012-10-28 16:06:17 +00:00
parent 6ed2e7bbd1
commit cc714af44c
3 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
library/PolyVoxCore/include/PolyVoxCore/LowPassFilter.inl
View File

@ -23,6 +23,13 @@ freely, subject to the following restrictions:
namespace PolyVox namespace PolyVox
{ {
/**
* \param pVolSrc
* \param regSrc
* \param[out] pVolDst
* \param regDst
* \param uKernelSize
*/
template< typename SrcVolumeType, typename DstVolumeType, typename AccumulationType> template< typename SrcVolumeType, typename DstVolumeType, typename AccumulationType>
LowPassFilter<SrcVolumeType, DstVolumeType, AccumulationType>::LowPassFilter(SrcVolumeType* pVolSrc, Region regSrc, DstVolumeType* pVolDst, Region regDst, uint32_t uKernelSize) LowPassFilter<SrcVolumeType, DstVolumeType, AccumulationType>::LowPassFilter(SrcVolumeType* pVolSrc, Region regSrc, DstVolumeType* pVolDst, Region regDst, uint32_t uKernelSize)
:m_pVolSrc(pVolSrc) :m_pVolSrc(pVolSrc)

2
library/PolyVoxCore/include/PolyVoxCore/MeshDecimator.inl
View File

@ -26,7 +26,7 @@ namespace PolyVox
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// Builds a MeshDecimator. /// Builds a MeshDecimator.
/// \param pInputMesh A pointer to the mesh to be decimated. /// \param pInputMesh A pointer to the mesh to be decimated.
/// \param pOutputMesh A pointer to where the result should be stored. Any existing /// \param[out] pOutputMesh A pointer to where the result should be stored. Any existing
/// contents will be deleted. /// contents will be deleted.
/// \param fEdgeCollapseThreshold This is only use in the case of a Marching Cubes /// \param fEdgeCollapseThreshold This is only use in the case of a Marching Cubes
/// surface and controls how close two normals must be to collapse. The dot product /// surface and controls how close two normals must be to collapse. The dot product

6
library/PolyVoxCore/include/PolyVoxCore/VolumeResampler.inl
View File

@ -25,6 +25,12 @@ freely, subject to the following restrictions:
namespace PolyVox namespace PolyVox
{ {
/**
* \param pVolSrc
* \param regSrc
* \param[out] pVolDst
* \param regDst
*/
template< typename SrcVolumeType, typename DstVolumeType> template< typename SrcVolumeType, typename DstVolumeType>
VolumeResampler<SrcVolumeType, DstVolumeType>::VolumeResampler(SrcVolumeType* pVolSrc, Region regSrc, DstVolumeType* pVolDst, Region regDst) VolumeResampler<SrcVolumeType, DstVolumeType>::VolumeResampler(SrcVolumeType* pVolSrc, Region regSrc, DstVolumeType* pVolDst, Region regDst)
:m_pVolSrc(pVolSrc) :m_pVolSrc(pVolSrc)