Improve interface documentation a bit

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

diff --git a/source/program.h b/source/program.h
index b41f9ac225e9edc724b18d375b278e4793b6b15b..e78c8ccd0bfef96d0da006827bd6e22dee527973 100644 (file)
--- a/source/program.h
+++ b/source/program.h
@@ -14,6 +14,10 @@ namespace GL {
 
 class Shader;
 
+/**
+A complete shader program.  Programs can be assembled of individual Shaders or
+generated with a set of standard features.
+*/
 class Program: public Bindable<Program>
 {
 public:
@@ -68,9 +72,15 @@ private:
        bool legacy_vars;
 
 public:
+       /// Constructs an empty Program with no Shaders attached.
        Program();
+
+       /// Constructs a Program with standard features.
        Program(const ProgramBuilder::StandardFeatures &);
+
+       /// Constructs a Program from vertex and fragment shader source code.
        Program(const std::string &, const std::string &);
+
 private:
        void init();
 public: