doc improvement

[simgrid.git] / src / bindings / java / org / simgrid / msg / ProcessKilledError.java

diff --git a/src/bindings/java/org/simgrid/msg/ProcessKilledError.java b/src/bindings/java/org/simgrid/msg/ProcessKilledError.java
index 8011e3c..b9ebb49 100644 (file)
--- a/src/bindings/java/org/simgrid/msg/ProcessKilledError.java
+++ b/src/bindings/java/org/simgrid/msg/ProcessKilledError.java
@@ -1,4 +1,4 @@
-/* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2006-2019. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -6,7 +6,17 @@
 package org.simgrid.msg;
 
 /** Used internally to interrupt the user code when the process gets killed.
- * Don't catch it.
+ *
+ * You can catch it for cleanups or to debug, but DO NOT BLOCK IT, or your simulation will segfault!
+ *
+ * <code>
+ * try {
+ *   getHost().off();
+ * } catch (ProcessKilledError e) {
+ *   e.printStackTrace();
+ *   throw e;
+ * }
+ * </code>
  */
 
 public class ProcessKilledError extends Error {