Changes between Version 79 and Version 80 of j2p

Timestamp:

05/30/24 09:39:46 (5 months ago)

Author:

wouter

Comment:

--

j2p

@@ -18 +18 @@
 The repo contains the translator in the module named "core". The other modules, ending with "-t", are translator plug-ins described below.
 
-== Internal mechanism
+== Core Translation
 For normal use, you do not need to know exactly how the translation is done. But the way the translator works becomes highly relevant if you want to inject your own python translations into the code (see the following section). 
 
@@ -36 +36 @@
 
 But the translator can intercept special classes and make dedicated translations. For instance if a class C is implementing {{{Iterator}}} and it is of class C, translating {{{it.next()}}} gives {{{next(it)}}}, and the definition {{{void iterator()}}} translates to {{{__iter__(self)}}}. These are all handled in the translator classes, in this example in {{{tudelft.utilities.j2p.t.java.util.Iterator}}}.
+
+=== Comments
+The exact location of comments is very important as it determines to which java element the comment is attached to. And where it is attached to determines how it is translated, and which element it modifies if you use #PY annotations to override the translation (see below). 
+
+Generally, a comment attaches to the element that comes next to it. 
+
+||next element||placement of comment in translation||
+||@Annotation||before the annotation||
+||method declaration, method modifier||first item in the method||
+||class declaration||before the class||
+
+Therefore, we recommend to place method @Annotations **before** the javadoc, like this
+{{{
+@NonNull @Override
+/** @return  a string representation of the object ....*/
+public String toString() { ... }
+}}} 
 
 ==== constructs