X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/0e9c0448c6566825b170b98ecff716b098bda10e..ea74f5d95928a521a588737e81f1de94eef25d19:/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 144f7fbc3f..8f76d01fa8 100644
--- a/src/bindings/java/org/simgrid/msg/ProcessKilledError.java
+++ b/src/bindings/java/org/simgrid/msg/ProcessKilledError.java
@@ -1,16 +1,25 @@
-/*
- * Copyright (c) 2006-2013. 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.
- */
+/* Copyright (c) 2006-2022. 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. */
+
 package org.simgrid.msg;
 
-/** This error class is only used to interrupt the java user code 
- * when the process gets killed by an external event.
- * Don't catch it.
+/** Used internally to interrupt the user code when the process gets killed.
+ *
+ * @beginrst
+ * You can catch it for cleanups or to debug, but DO NOT BLOCK IT, or your simulation will segfault!
+ *
+ * .. code-block:: java
+ *
+ *    try {
+ *      getHost().off();
+ *    } catch (ProcessKilledError e) {
+ *      e.printStackTrace();
+ *      throw e;
+ *    }
+ *
+ * @endrst
  */
 
 public class ProcessKilledError extends Error {