More documentation of actions

[popboot.git] / action.h

diff --git a/action.h b/action.h
index 32d91220888a23a0bbc9fc814433b9c5a30b84e0..40e2db3137e4481e7adcad2be73f3ec75ed8a0f2 100644 (file)
--- a/action.h
+++ b/action.h
@@ -6,8 +6,11 @@
 #include <ext/hash_map>
 #include <locale>
 
+//! A list of strings, each string representing an effect.
 typedef std::vector<std::string> Literals;
+//! A map, but really a list of pairs, the precondition as a string, and a bool, true if it's a hard precondition, otherwise false.
 typedef __gnu_cxx::hash_map<std::string,bool> Preconditions;
+//! A map from returnvalue of the execution to the effects achieved.
 typedef __gnu_cxx::hash_map<int,Literals> EffectsMap;
 
 // These are needed to be able to use std::string as key in a hash_map.