fixes for automatically generated API docs

metadata
Wenzel Jakob 2013-11-13 11:16:24 +00:00
parent 7c150c6902
commit 7df82cee18
8 changed files with 1691 additions and 946 deletions

File diff suppressed because it is too large Load Diff

View File

@ -246,5 +246,6 @@ namespace std {
}
};
#endif
/// \endcond
#endif /* __MITSUBA_CORE_PLATFORM_H_ */

View File

@ -125,7 +125,7 @@ inline Point2 sample02(size_t n) {
}
/**
* \ref Generate fast and reasonably good pseudorandom numbers using the
* \brief Generate fast and reasonably good pseudorandom numbers using the
* Tiny Encryption Algorithm (TEA) by David Wheeler and Roger Needham.
*
* For details, refer to "GPU Random Numbers via the Tiny Encryption Algorithm"
@ -216,10 +216,10 @@ extern MTS_EXPORT_CORE Float radicalInverseIncremental(int base, Float x);
* functions for the first 1024 prime number bases. For that reason, only works for
* such bases.
*
* \ref baseIndex
* \param baseIndex
* Prime number index starting at 0 (i.e. 3 would cause 7 to be
* used as the basis)
* \ref perm
* \param index
* Sequence index
*/
extern MTS_EXPORT_CORE Float radicalInverseFast(uint16_t baseIndex, uint64_t index);

View File

@ -45,7 +45,7 @@ class MTS_EXPORT_CORE ReconstructionFilter : public ConfigurableObject {
public:
/**
* \brief When resampling data to a different resolution using
* \ref Resample, this enumeration specifies how lookups
* \ref Resampler::resample(), this enumeration specifies how lookups
* <em>outside</em> of the input domain are handled.
*
* \see Resampler

View File

@ -736,7 +736,7 @@ public:
* red-green color opponency, and \c T (tritan) encodes
* blue-red color opponency. For normalized input, the
* range of attainable values is given by
* \f I\in $[0,1], P,T\in [-1,1]\f$.
* \f$ I\in $[0,1], P,T\in [-1,1]\f$.
*
* In the Python API, this function returns a 3-tuple
* with the result of the operation.

View File

@ -24,8 +24,9 @@
MTS_NAMESPACE_BEGIN
/*! \addtogroup libcore */
/*! @{ */
/*! \addtogroup libcore
* @{
*/
// -----------------------------------------------------------------------
//! @{ \name String-related utility functions
@ -559,6 +560,8 @@ extern MTS_EXPORT_CORE Float fresnelDielectricExt(Float cosThetaI,
*
* \param cosThetaI
* Cosine of the angle between the normal and the incident ray
* \param eta
* Relative refractive index
*/
inline Float fresnelDielectricExt(Float cosThetaI, Float eta) { Float cosThetaT;
return fresnelDielectricExt(cosThetaI, cosThetaT, eta); }

View File

@ -40,19 +40,19 @@ public:
/// Uniformly sample a vector on the unit sphere with respect to solid angles
static Vector squareToUniformSphere(const Point2 &sample);
/// Density of \ref squareToSphere with respect to solid angles
/// Density of \ref squareToUniformSphere() with respect to solid angles
static inline Float squareToUniformSpherePdf() { return INV_FOURPI; }
/// Uniformly sample a vector on the unit hemisphere with respect to solid angles
static Vector squareToUniformHemisphere(const Point2 &sample);
/// Density of \ref squareToHemiphere with respect to solid angles
/// Density of \ref squareToUniformHemisphere() with respect to solid angles
static inline Float squareToUniformHemispherePdf() { return INV_TWOPI; }
/// Sample a cosine-weighted vector on the unit hemisphere with respect to solid angles
static Vector squareToCosineHemisphere(const Point2 &sample);
/// Density of \ref squareToCosineHemiphere with respect to solid angles
/// Density of \ref squareToCosineHemisphere() with respect to solid angles
static inline Float squareToCosineHemispherePdf(const Vector &d)
{ return INV_PI * Frame::cosTheta(d); }