Commit ba6b4140 authored by Matthew Dawson's avatar Matthew Dawson
Browse files

Add some documentation to EventBProject, quickly detailing it.

Add some basic documentation to EventBProject, mainly documenting there are
some known failure cases that are being addressed, but are not ready yet.
parent b2180f1c
Loading
Loading
Loading
Loading
+5 −0
Original line number Diff line number Diff line
@@ -32,6 +32,11 @@ import ca.mcscert.jtet.tabularexpression.Table;
import java.io.*;

/**
 * EventB project generator.
 * <p>
 * This the starting point for work in progress EventB generator.  While it can successfully generate tables that are
 * usable in the Rodin environment, some tables may need some modifications to work properly.  In a future release this
 * will be addressed.
 *
 * @author Yanjun Jiang <jiangy76@mcmaster.ca>
 */