Comment updates

[builder.git] / source / buildinfo.h

diff --git a/source/buildinfo.h b/source/buildinfo.h
index f10e21e5aeee4f3a24c78cfbca194b897c13b16d..18f33a093676a2d98c54b4a3c2c9a338d8c10df7 100644 (file)
--- a/source/buildinfo.h
+++ b/source/buildinfo.h
@@ -27,9 +27,9 @@ public:
        
        enum UpdateLevel
        {
-               LOCAL,
-               DEPENDENCY,
-               CHAINED
+               LOCAL,       //< Include all information
+               DEPENDENCY,  //< Include all but code generation options
+               CHAINED      //< Include only compilation options
        };
 
        typedef std::map<std::string, std::string> DefineMap;
@@ -46,7 +46,10 @@ public:
 
        BuildInfo();
 
-       /** Adds another BuildInfo to the end of this one. */
+       /** Updates the BuildInfo from another one.  Lists are concatenated, with
+       the first occurrence of each item preserved.  Scalars are overwritten.
+       
+       The update level determines what information is updated. */
        void update_from(const BuildInfo &, UpdateLevel = LOCAL);
 
        /** Makes sure there are no duplicate entries in the lists.  For warnings,