From: Michael Andreen <harv@ruin.nu>
Date: Sat, 26 Jan 2008 15:47:27 +0000 (+0100)
Subject: More documentation of actions
X-Git-Url: https://ruin.nu/git/?a=commitdiff_plain;ds=sidebyside;h=eb070a26e716bd66a085beacc70a98a2e8fae0f7;p=popboot.git

More documentation of actions
---

diff --git a/action.h b/action.h
index 32d9122..40e2db3 100644
--- 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.