Improve interface documentation a bit

[libs/gl.git] / source / shader.h

diff --git a/source/shader.h b/source/shader.h
index 63af9b3ab74862c10fb417b68bdaa18786c8e9b9..961cb6944fb5f553ad3abbdb5af90675ac897230 100644 (file)
--- a/source/shader.h
+++ b/source/shader.h
@@ -7,6 +7,12 @@
 namespace Msp {
 namespace GL {
 
+/**
+A single shader stage.  Shaders must be attached to a Program to be used.
+
+This class can't be instantiated directly.  Use one of the VertexShader and
+FragmentShader classes to create Shaders.
+*/
 class Shader
 {
 private: