Add some documentation to the GLSL compiler

[libs/gl.git] / source / glsl / debug.h

diff --git a/source/glsl/debug.h b/source/glsl/debug.h
index 6aca7af0fb2a94b0aab0b8936f1c9ea902021d2a..87ec4734e0b1bda18e4513a481688bbfee693fc0 100644 (file)
--- a/source/glsl/debug.h
+++ b/source/glsl/debug.h
@@ -8,6 +8,8 @@ namespace Msp {
 namespace GL {
 namespace SL {
 
+/** Creates a textual representation of the syntax tree.  The result is encoded
+as UTF-8. */
 class DumpTree: private TraversingVisitor
 {
 private: