Documented generic blocks

diff --git a/fres/contract/fres_blocks.idl b/fres/contract/fres_blocks.idl
index 65b224d8b28dea1c2d3e5bf9ed286b740c91da56..8dfcd31e7e5c3e4f9ecfa7f731e1b9fb843a32c4 100644 (file)
--- a/fres/contract/fres_blocks.idl
+++ b/fres/contract/fres_blocks.idl
@@ -47,15 +47,18 @@ module fres {
 
        /// Blocks from which contracts are composed
        module block {
-
+               /// Contract label
                struct label {
                        char label[32];
                };
-               
+
+               /// Resource for which this contract is 
                struct resource {
                        frsh_resource_type_t resource_type;
                        frsh_resource_id_t   resource_id;
                };
+
+               /// Basic contract parameters
                struct basic {
                        // forb_contract_params_type == FORB_CONTRACT_PARAMS_BASIC
                        fosa_rel_time_t      budget;
@@ -63,6 +66,8 @@ module fres {
                        frsh_workload_t      workload;
                        frsh_contract_type_t contract_type;
                };
+
+               /// Timing requirements
                struct timing_reqs {
                        boolean                 d_equals_t;
                        fosa_rel_time_t         deadline;
@@ -75,7 +80,8 @@ module fres {
 //                     frsh_signal_t           deadline_miss_signal;
 //                     frsh_signal_info_t      deadline_miss_siginfo;
                };
-               
+
+               /// Spare capacity
                struct spare_capacity {
                        frsh_granularity_t      granularity;
                        long                    importance;