From 86209e4b6d1cdcc4542386c08aa4589f01dc410f Mon Sep 17 00:00:00 2001 From: Laurent Bobelin Date: Mon, 14 Nov 2011 11:32:10 +0100 Subject: [PATCH] Corrected some typos, clarified the index. --- doc/index.doc | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/doc/index.doc b/doc/index.doc index 7cdbac464f..490db7d57c 100644 --- a/doc/index.doc +++ b/doc/index.doc @@ -4,21 +4,19 @@ Simgrid-java is a java API that let you use SimGrid MSG API in your favorite language (java). Without it, you would be forced to use C or one of the other bindings provided. -MSG was the first distributed programming environment provided within -SimGrid. While almost realistic, it remains quite simple (simplistic?). -This describes the Java bindings to this interface. +MSG was the first distributed programming environment provided within SimGrid. While almost realistic, it remains quite simple. This describes the Java bindings to this interface. \section jMSG_who Who should use this (and who shouldn't) You should use MSG if you want to study some heuristics for a -given problem you don't really want to implement. If you want to -use the Java programming language, your are in the right -section. +given problem you don't really want to implement. SimGrid-java let you use MSG while coding in Java. So if your need is MSG + Java, you're in the right section ! + +\section SimGrid-java usage overview To make a long story short, it's a JNI binding, so it implies that : \li Most of the MSG and SimGrid documentation about behavioral aspects applies directly to what you are programming. \li MSG data structures are mapped to Java objects. So it means that from the syntaxic point of view, you have to know how those objects are. Fortunately, we have generated the Javadoc for those objects. So take a look at it -Finally, it implies also that you program can crash for 3 main reasons : +Finally, it implies also that your program can crash for 3 main reasons : \li Your Java part is not good : you'll have a good old java exception thrown, and hence you should be able to correct it by yourself. \li Our java part is not good : you'll also have a java exception thrown, but we have real doubts this can happen, since the java part is only a JNI binding. The other option is that it crashed because you used incorrectly the MSG API, so this means also you should have a MSGException. It means you should read carefully MSG samples and/or documentation. -- 2.20.1