From 394dd0d3119351ba2919025a2e484f4c490ab755 Mon Sep 17 00:00:00 2001
From: Wenzel Jakob <wenzel@cs.cornell.edu>
Date: Fri, 19 Aug 2011 03:28:39 -0400
Subject: [PATCH] further documentation updates

---
 include/mitsuba/bidir/rsampler.h  | 7 +++++--
 include/mitsuba/hw/basicshader.h  | 5 +++++
 include/mitsuba/hw/device.h       | 3 +++
 include/mitsuba/hw/font.h         | 1 +
 include/mitsuba/hw/glgeometry.h   | 1 +
 include/mitsuba/hw/glprogram.h    | 1 +
 include/mitsuba/hw/glrenderer.h   | 1 +
 include/mitsuba/hw/glsync.h       | 1 +
 include/mitsuba/hw/gltexture.h    | 1 +
 include/mitsuba/hw/glxdevice.h    | 1 +
 include/mitsuba/hw/glxrenderer.h  | 1 +
 include/mitsuba/hw/gpugeometry.h  | 1 +
 include/mitsuba/hw/gpuprogram.h   | 1 +
 include/mitsuba/hw/gpusync.h      | 1 +
 include/mitsuba/hw/gputexture.h   | 1 +
 include/mitsuba/hw/nsglrenderer.h | 1 +
 include/mitsuba/hw/nsglsession.h  | 1 +
 include/mitsuba/hw/renderer.h     | 4 +++-
 include/mitsuba/hw/session.h      | 1 +
 include/mitsuba/hw/viewer.h       | 2 ++
 include/mitsuba/hw/vpl.h          | 2 ++
 include/mitsuba/hw/wgldevice.h    | 1 +
 include/mitsuba/hw/wglrenderer.h  | 1 +
 include/mitsuba/hw/wglsession.h   | 1 +
 include/mitsuba/hw/x11device.h    | 1 +
 include/mitsuba/hw/x11session.h   | 1 +
 26 files changed, 40 insertions(+), 3 deletions(-)

diff --git a/include/mitsuba/bidir/rsampler.h b/include/mitsuba/bidir/rsampler.h
index f6d51944..8e26457a 100644
--- a/include/mitsuba/bidir/rsampler.h
+++ b/include/mitsuba/bidir/rsampler.h
@@ -24,12 +24,15 @@
 MTS_NAMESPACE_BEGIN
 
 /**
- * Specialized sampler implementation used to seed MLT-style algorithm. Allows
- * to query for the current sample index, which can later be used to rewind
+ * \brief Specialized sampler implementation used to seed MLT-style algorithm. 
+ *
+ * Allows to query for the current sample index, which can later be used to rewind
  * back to this state. In the case of MLT, this makes it possible to sample paths 
  * approximately proportional to their contribution without actually having
  * to store millions of path. Note that `rewinding' is naive -- it just 
  * resets & regenerates the whole random number sequence, which might be slow.
+ *
+ * \ingroup libbidir
  */
 class MTS_EXPORT_BIDIR ReplayableSampler : public Sampler {
 public:
diff --git a/include/mitsuba/hw/basicshader.h b/include/mitsuba/hw/basicshader.h
index 35b0145c..61581b5d 100644
--- a/include/mitsuba/hw/basicshader.h
+++ b/include/mitsuba/hw/basicshader.h
@@ -34,6 +34,7 @@ MTS_NAMESPACE_BEGIN
  * \brief Constant spectrum-valued texture
  *
  * Includes a \ref Shader implementation for hardware rendering
+ * \ingroup libhw
  */
 class MTS_EXPORT_HW ConstantSpectrumTexture : public Texture {
 public:
@@ -82,6 +83,7 @@ protected:
  * \brief Constant float-valued texture
  *
  * Includes a \ref Shader implementation for hardware rendering
+ * \ingroup libhw
  */
 class MTS_EXPORT_HW ConstantFloatTexture : public Texture {
 public:
@@ -130,6 +132,7 @@ protected:
  * \brief Componentwise addition of two textures
  *
  * Includes a \ref Shader implementation for hardware rendering
+ * \ingroup libhw
  */
 class MTS_EXPORT_HW SpectrumAdditionTexture : public Texture {
 public:
@@ -181,6 +184,7 @@ protected:
  * \brief Componentwise subtraction of two textures
  *
  * Includes a \ref Shader implementation for hardware rendering
+ * \ingroup libhw
  */
 class MTS_EXPORT_HW SpectrumSubtractionTexture : public Texture {
 public:
@@ -232,6 +236,7 @@ protected:
  * \brief Componentwise product of two textures
  *
  * Includes a \ref Shader implementation for hardware rendering
+ * \ingroup libhw
  */
 class MTS_EXPORT_HW SpectrumProductTexture : public Texture {
 public:
diff --git a/include/mitsuba/hw/device.h b/include/mitsuba/hw/device.h
index 79334b8c..ff403046 100644
--- a/include/mitsuba/hw/device.h
+++ b/include/mitsuba/hw/device.h
@@ -28,6 +28,7 @@ class Renderer;
 
 /** \brief The device event structure encapsulates event
  * information such as mouse movement or key presses
+ * \ingroup libhw
  */
 struct MTS_EXPORT_HW DeviceEvent {
 public:
@@ -114,6 +115,7 @@ private:
 };
 
 /** \brief Abstract device event callback
+ * \ingroup libhw
  */
 class MTS_EXPORT_HW DeviceEventListener {
 public:
@@ -128,6 +130,7 @@ protected:
 };
 
 /** \brief An abstract drawing device
+ * \ingroup libhw
  */
 class MTS_EXPORT_HW Device : public Object {
 public:
diff --git a/include/mitsuba/hw/font.h b/include/mitsuba/hw/font.h
index 3e90f8f6..2b01eb8d 100644
--- a/include/mitsuba/hw/font.h
+++ b/include/mitsuba/hw/font.h
@@ -28,6 +28,7 @@ MTS_NAMESPACE_BEGIN
  *
  * A FreeType2-based generation tool is located in the directory
  * 'tools/linux/fontgen'. Only Latin-1 is supported at the moment.
+ * \ingroup libhw
  */
 class MTS_EXPORT_HW Font : public Object {
 public:
diff --git a/include/mitsuba/hw/glgeometry.h b/include/mitsuba/hw/glgeometry.h
index 98e7743a..fa418fd0 100644
--- a/include/mitsuba/hw/glgeometry.h
+++ b/include/mitsuba/hw/glgeometry.h
@@ -25,6 +25,7 @@
 MTS_NAMESPACE_BEGIN
 
 /** \brief OpenGL-based GPUGeometry implementation
+ * \ingroup libhw
  */
 class MTS_EXPORT_HW GLGeometry : public GPUGeometry {
 	friend class GLRenderer;
diff --git a/include/mitsuba/hw/glprogram.h b/include/mitsuba/hw/glprogram.h
index bce3d773..6e53950c 100644
--- a/include/mitsuba/hw/glprogram.h
+++ b/include/mitsuba/hw/glprogram.h
@@ -26,6 +26,7 @@ MTS_NAMESPACE_BEGIN
 
 /** \brief OpenGL shader class -- responsible from compiling
  * and linking GLSL fragments
+ * \ingroup libhw
  */
 class MTS_EXPORT_HW GLProgram : public GPUProgram {
 public:
diff --git a/include/mitsuba/hw/glrenderer.h b/include/mitsuba/hw/glrenderer.h
index 450c56ef..b479808d 100644
--- a/include/mitsuba/hw/glrenderer.h
+++ b/include/mitsuba/hw/glrenderer.h
@@ -46,6 +46,7 @@ MTS_NAMESPACE_BEGIN
 
 /**
  * \brief OpenGL implementation of the \ref Renderer interface
+ * \ingroup libhw
  */
 class MTS_EXPORT_HW GLRenderer : public Renderer {
 public:
diff --git a/include/mitsuba/hw/glsync.h b/include/mitsuba/hw/glsync.h
index 56b672c0..eec90639 100644
--- a/include/mitsuba/hw/glsync.h
+++ b/include/mitsuba/hw/glsync.h
@@ -25,6 +25,7 @@
 MTS_NAMESPACE_BEGIN
 
 /** \brief OpenGL-based GPUSync implementation
+ * \ingroup libhw
  */
 class MTS_EXPORT_HW GLSync : public GPUSync {
 public:
diff --git a/include/mitsuba/hw/gltexture.h b/include/mitsuba/hw/gltexture.h
index 4a9f9428..2b07a060 100644
--- a/include/mitsuba/hw/gltexture.h
+++ b/include/mitsuba/hw/gltexture.h
@@ -25,6 +25,7 @@
 MTS_NAMESPACE_BEGIN
 
 /** \brief OpenGL-based GPUTexture implementation
+ * \ingroup libhw
  */
 class MTS_EXPORT_HW GLTexture : public GPUTexture {
 public:
diff --git a/include/mitsuba/hw/glxdevice.h b/include/mitsuba/hw/glxdevice.h
index a4350b81..8369bb9e 100644
--- a/include/mitsuba/hw/glxdevice.h
+++ b/include/mitsuba/hw/glxdevice.h
@@ -24,6 +24,7 @@
 MTS_NAMESPACE_BEGIN
 
 /** \brief X Windows OpenGL-capable (GLX) device
+ * \ingroup libhw
  */
 class MTS_EXPORT_HW GLXDevice : public X11Device {
 public:
diff --git a/include/mitsuba/hw/glxrenderer.h b/include/mitsuba/hw/glxrenderer.h
index 2e9f0fa9..a6b4eb4b 100644
--- a/include/mitsuba/hw/glxrenderer.h
+++ b/include/mitsuba/hw/glxrenderer.h
@@ -25,6 +25,7 @@
 MTS_NAMESPACE_BEGIN
 
 /** \brief GLX (XFree86) renderer
+ * \ingroup libhw
  */
 class MTS_EXPORT_HW GLXRenderer : public GLRenderer {
 public:
diff --git a/include/mitsuba/hw/gpugeometry.h b/include/mitsuba/hw/gpugeometry.h
index 0f4cd704..b6c12c06 100644
--- a/include/mitsuba/hw/gpugeometry.h
+++ b/include/mitsuba/hw/gpugeometry.h
@@ -24,6 +24,7 @@
 MTS_NAMESPACE_BEGIN
 
 /** \brief Abstract geometry storage on a graphics card
+ * \ingroup libhw
  */
 class MTS_EXPORT_HW GPUGeometry : public Object {
 public:
diff --git a/include/mitsuba/hw/gpuprogram.h b/include/mitsuba/hw/gpuprogram.h
index 79a9e3b7..a9a1f64a 100644
--- a/include/mitsuba/hw/gpuprogram.h
+++ b/include/mitsuba/hw/gpuprogram.h
@@ -24,6 +24,7 @@
 MTS_NAMESPACE_BEGIN
 
 /** \brief Abstract shader program (for fragment/vertex shading)
+ * \ingroup libhw
  */
 class MTS_EXPORT_HW GPUProgram : public Object {
 public:
diff --git a/include/mitsuba/hw/gpusync.h b/include/mitsuba/hw/gpusync.h
index 52610a42..e053a049 100644
--- a/include/mitsuba/hw/gpusync.h
+++ b/include/mitsuba/hw/gpusync.h
@@ -25,6 +25,7 @@ MTS_NAMESPACE_BEGIN
 
 /** \brief Abstract GPU synchronization object implementing
  * a memory fence operation.
+ * \ingroup libhw
  */
 class MTS_EXPORT_HW GPUSync : public Object {
 public:
diff --git a/include/mitsuba/hw/gputexture.h b/include/mitsuba/hw/gputexture.h
index c1d91f7b..2a165d09 100644
--- a/include/mitsuba/hw/gputexture.h
+++ b/include/mitsuba/hw/gputexture.h
@@ -26,6 +26,7 @@ MTS_NAMESPACE_BEGIN
 
 /** \brief A data structure for 1/2/3D and cube texture mapping. Also
  * has optional render-to-texture functionality.
+ * \ingroup libhw
  */
 class MTS_EXPORT_HW GPUTexture : public Object {
 public:
diff --git a/include/mitsuba/hw/nsglrenderer.h b/include/mitsuba/hw/nsglrenderer.h
index 061bf9f4..9f2580e2 100644
--- a/include/mitsuba/hw/nsglrenderer.h
+++ b/include/mitsuba/hw/nsglrenderer.h
@@ -29,6 +29,7 @@
 MTS_NAMESPACE_BEGIN
 
 /** \brief A MacOS X (NSGL) OpenGL Renderer
+ * \ingroup libhw
  */
 class MTS_EXPORT_HW NSGLRenderer : public GLRenderer {
 public:
diff --git a/include/mitsuba/hw/nsglsession.h b/include/mitsuba/hw/nsglsession.h
index 47703edd..ae92d7f1 100644
--- a/include/mitsuba/hw/nsglsession.h
+++ b/include/mitsuba/hw/nsglsession.h
@@ -24,6 +24,7 @@
 MTS_NAMESPACE_BEGIN
 
 /** \brief A MacOS X (NSGL) windowing environment session
+ * \ingroup libhw
  */
 class MTS_EXPORT_HW NSGLSession : public Session {
 public:
diff --git a/include/mitsuba/hw/renderer.h b/include/mitsuba/hw/renderer.h
index 92d646d1..c591b1f0 100644
--- a/include/mitsuba/hw/renderer.h
+++ b/include/mitsuba/hw/renderer.h
@@ -33,7 +33,8 @@ class Bitmap;
 class Font;
 
 /**
- * Helper class, which documents the capabilities of a renderer implementation
+ * \brief Helper class, which documents the capabilities of a renderer implementation
+ * \ingroup libhw
  */
 class MTS_EXPORT_HW RendererCapabilities : public Object {
 public:
@@ -71,6 +72,7 @@ protected:
 };
 
 /** \brief Abstract renderer implementation
+ * \ingroup libhw
  */
 class MTS_EXPORT_HW Renderer : public Object {
 public:
diff --git a/include/mitsuba/hw/session.h b/include/mitsuba/hw/session.h
index cfd067f0..f4a842dc 100644
--- a/include/mitsuba/hw/session.h
+++ b/include/mitsuba/hw/session.h
@@ -26,6 +26,7 @@ MTS_NAMESPACE_BEGIN
 class Device;
 
 /** \brief Abstract windowing environment session
+ * \ingroup libhw
  */
 class MTS_EXPORT_HW Session : public Object {
 	friend class Device;
diff --git a/include/mitsuba/hw/viewer.h b/include/mitsuba/hw/viewer.h
index 5ec99316..593e671c 100644
--- a/include/mitsuba/hw/viewer.h
+++ b/include/mitsuba/hw/viewer.h
@@ -30,6 +30,8 @@ MTS_NAMESPACE_BEGIN
  *
  * This class makes it possible to rapidly prototype simple OpenGL
  * applications, which can be started using the 'mtsutil' launcher.
+ *
+ * \ingroup libhw
  */
 class MTS_EXPORT_HW Viewer : public Utility, public DeviceEventListener {
 public:
diff --git a/include/mitsuba/hw/vpl.h b/include/mitsuba/hw/vpl.h
index ef6bcbe0..4a582ad0 100644
--- a/include/mitsuba/hw/vpl.h
+++ b/include/mitsuba/hw/vpl.h
@@ -36,6 +36,8 @@ MTS_NAMESPACE_BEGIN
  * properties using uniforms, in which case already existing code 
  * can be reused and we get something more like lower case n squared
  * (where lower n is the number of material types).
+ *
+ * \ingroup libhw
  */
 class MTS_EXPORT_HW VPLShaderManager : public Object {
 public:
diff --git a/include/mitsuba/hw/wgldevice.h b/include/mitsuba/hw/wgldevice.h
index 30c4f61a..f8e7dd88 100644
--- a/include/mitsuba/hw/wgldevice.h
+++ b/include/mitsuba/hw/wgldevice.h
@@ -25,6 +25,7 @@
 MTS_NAMESPACE_BEGIN
 
 /** \brief Windows (WGL) device implementation
+ * \ingroup libhw
  */
 class MTS_EXPORT_HW WGLDevice : public Device {
 public:
diff --git a/include/mitsuba/hw/wglrenderer.h b/include/mitsuba/hw/wglrenderer.h
index ed4818dd..4dccedaa 100644
--- a/include/mitsuba/hw/wglrenderer.h
+++ b/include/mitsuba/hw/wglrenderer.h
@@ -25,6 +25,7 @@
 MTS_NAMESPACE_BEGIN
 
 /** \brief Windows (WGL) renderer implementation
+ * \ingroup libhw
  */
 class MTS_EXPORT_HW WGLRenderer : public GLRenderer {
 public:
diff --git a/include/mitsuba/hw/wglsession.h b/include/mitsuba/hw/wglsession.h
index acf75a22..af7d0da4 100644
--- a/include/mitsuba/hw/wglsession.h
+++ b/include/mitsuba/hw/wglsession.h
@@ -24,6 +24,7 @@
 MTS_NAMESPACE_BEGIN
 
 /** \brief Windows (WGL) windowing environment session
+ * \ingroup libhw
  */
 class MTS_EXPORT_HW WGLSession : public Session {
 	friend class WGLDevice;
diff --git a/include/mitsuba/hw/x11device.h b/include/mitsuba/hw/x11device.h
index e6e3b8f4..d70ebd4d 100644
--- a/include/mitsuba/hw/x11device.h
+++ b/include/mitsuba/hw/x11device.h
@@ -25,6 +25,7 @@
 MTS_NAMESPACE_BEGIN
 
 /** \brief X Window System (X11R6) device / software surface
+ * \ingroup libhw
  */
 class MTS_EXPORT_HW X11Device : public Device {
 	friend class X11Session;
diff --git a/include/mitsuba/hw/x11session.h b/include/mitsuba/hw/x11session.h
index 8632d4bc..5d54b2b5 100644
--- a/include/mitsuba/hw/x11session.h
+++ b/include/mitsuba/hw/x11session.h
@@ -26,6 +26,7 @@
 MTS_NAMESPACE_BEGIN
 
 /** \brief X Window System (X11R6) session
+ * \ingroup libhw
  */
 class MTS_EXPORT_HW X11Session : public Session {
 	friend class X11Device;