From: Eric Anholt <eric@anholt.net>
Date: Wed, 18 Apr 2012 21:40:10 +0000 (-0700)
Subject: glsl: Add doxygen explaining what main.cpp is for.
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=6a6cb03507da75a30224020c9193464ca5b81c5f;p=mesa.git

glsl: Add doxygen explaining what main.cpp is for.

I keep getting lost in the Makefile trying to figure out what to edit
to work on builtin_compiler or glsl_compiler.

Reviewed-by: Kenneth Graunke <kenneth@whitecape.org>
---

diff --git a/src/glsl/main.cpp b/src/glsl/main.cpp
index 3231b1be936..64c2496eba8 100644
--- a/src/glsl/main.cpp
+++ b/src/glsl/main.cpp
@@ -22,6 +22,15 @@
  */
 #include <getopt.h>
 
+/** @file main.cpp
+ *
+ * This file is the main() routine and scaffolding for producing
+ * builtin_compiler (which doesn't include builtins itself and is used
+ * to generate the profile information for builtin_function.cpp), and
+ * for glsl_compiler (which does include builtins and can be used to
+ * offline compile GLSL code and examine the resulting GLSL IR.
+ */
+
 #include "ast.h"
 #include "glsl_parser_extras.h"
 #include "ir_optimization.h"