Document a lot of classes and functions

[builder.git] / source / gnulinker.h

diff --git a/source/gnulinker.h b/source/gnulinker.h
index 673056e9c9b878c3d425c8815212d859de97cfcc..6bd11ca441afda7f4be2e275d4ce80862894de2e 100644 (file)
--- a/source/gnulinker.h
+++ b/source/gnulinker.h
@@ -3,6 +3,13 @@
 
 #include "tool.h"
 
+/**
+The GNU linker.  Turns ObjectFiles into Executables and SharedLibraries.  To
+create a shared library, specify "shared" as the second argument to
+create_target.
+
+Uses either gcc or g++ depending on what was used to compile the object files.
+*/
 class GnuLinker: public Tool
 {
 private: