Update and improve documentation

[libs/gl.git] / source / render / windowview.h

diff --git a/source/render/windowview.h b/source/render/windowview.h
index e61107a4790c2d492eda33c89de11af02b0213fa..9646a65d746ebcef6e7e5aa15db422d93dc5d602 100644 (file)
--- a/source/render/windowview.h
+++ b/source/render/windowview.h
@@ -9,6 +9,14 @@
 namespace Msp {
 namespace GL {
 
+/**
+A view targeting a Graphics::Window.
+
+After rendering, buffers are swapped to show the result in the window.
+
+The aspect ratio of the view's Camera is automatically updated to match that of
+the window.
+*/
 class WindowView: public View, public sigc::trackable
 {
 private: