Document a lot of classes and functions

[builder.git] / source / gnucompiler.h

diff --git a/source/gnucompiler.h b/source/gnucompiler.h
index 9d025edbf791bf326440e49f7e12837973caf016..d953e47f3c847a64cc794906dfaa186f7ead52d9 100644 (file)
--- a/source/gnucompiler.h
+++ b/source/gnucompiler.h
@@ -3,6 +3,13 @@
 
 #include "tool.h"
 
+/**
+Common base class for GNU compilers.  Turns SourceFiles into ObjectFiles.
+
+Since invocation is mostly the same for all language frontends, most of the
+logic is here and the individual tools only handle creating source files of
+appropriate type.
+*/
 class GnuCompiler: public Tool
 {
 protected: