Doc/comments

git-svn-id: https://www.prismmodelchecker.org/svn/prism/prism/trunk@3332 bbc10eb1-c90d-0410-af57-cb519fbb1720

prism/src/prism/Prism.java

@@ -1170,8 +1170,9 @@ public class Prism implements PrismSettingsListener
 		JDD.Deref(tmp);
 	}
 	
-	// export trans to a dot file
-	
+	/**
+	 * Export the MTBDD for a model's transition matrix to a Dot file.
+	 */
 	public void exportToDotFile(Model model, File file) throws FileNotFoundException
 	{
 		mainLog.println("\nExporting to dot file \"" + file + "\"...");
@@ -1180,13 +1181,37 @@ public class Prism implements PrismSettingsListener
 		JDD.ExportDDToDotFileLabelled(model.getTrans(), file.getPath(), model.getDDVarNames());
 	}
 	
-	// alias for export transition matrix to a file (plain, matlab, ...)
-	
+	/**
+	 * Export a model's transition matrix to a file
+	 * @param model The model
+	 * @param ordered Ensure that (source) states are in ascending order?
+	 * @param exportType Type of export; one of: <ul>
+	 * <li> {@link #EXPORT_PLAIN} 
+	 * <li> {@link #EXPORT_MATLAB}
+	 * <li> {@link #EXPORT_DOT}
+	 * <li> {@link #EXPORT_MRMC}
+	 * <li> {@link #EXPORT_MRMC}
+	 * <li> {@link #EXPORT_DOT_STATES}
+	 * </ul>
+	 * @param file File to export to 
+	 */
 	public void exportToFile(Model model, boolean ordered, int exportType, File file) throws FileNotFoundException, PrismException
 	{ exportTransToFile(model, ordered, exportType, file); }
 	
-	// export transition matrix to a file (plain, matlab, ...)
-	
+	/**
+	 * Export a model's transition matrix to a file
+	 * @param model The model
+	 * @param ordered Ensure that (source) states are in ascending order?
+	 * @param exportType Type of export; one of: <ul>
+	 * <li> {@link #EXPORT_PLAIN} 
+	 * <li> {@link #EXPORT_MATLAB}
+	 * <li> {@link #EXPORT_DOT}
+	 * <li> {@link #EXPORT_MRMC}
+	 * <li> {@link #EXPORT_MRMC}
+	 * <li> {@link #EXPORT_DOT_STATES}
+	 * </ul>
+	 * @param file File to export to 
+	 */
 	public void exportTransToFile(Model model, boolean ordered, int exportType, File file) throws FileNotFoundException, PrismException
 	{
 		// can only do ordered version of export for MDPs