Skip to content

Commit fd3033b

Browse files
authored
Update README.md
1 parent e028f5c commit fd3033b

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,9 @@ cd src/java
9999
| High-level API designed for communication with the railroad system | <messaging_path_prefix>.communication | Communication technology independent API designed for further use in the components. | baloghlaszlo |
100100
| Common messages | <messaging_path_prefix>.messages | Common representation for the messages used over the network in Java. | benedekh |
101101
| Messaging service + Dispatcher | <messaging_path_prefix>.mms | Messaging service and message dispatcher to dispatch different messages. | baloghlaszlo, benedekh |
102-
| Protobuf specific classes and message definitions | <messaging_path_prefix>.proto | Message definitions in protobuf representation and protobuf specific transformators for the messages. | hegyibalint, benedekh |
102+
| Protobuf specific classes | <messaging_path_prefix>.proto | Protobuf specific transformators and dispatcher for the messages. | benedekh |
103+
104+
| Protobuf message definitions | <messaging_path_prefix>.proto.messages | Message definitions in protobuf representation and Java classes generated from them. | hegyibalint, benedekh |
103105

104106
- Test folder path: `<root_path>/test/`
105107
- Test project prefix: `hu.bme.mit.inf.modes3.test`
@@ -166,7 +168,11 @@ cd src/java
166168

167169
- Should you use Eclipse with the Gradle plugin AND change something in any of the *.gradle files (either in the root `/src/java` folder or in your project's folder), do not forget to click on the project name with the right mouse button, and in the dropdown menu go to Gradle -> Plugin refresh. Otherwise, the plugin might not recognize the changes and will end up in an incorrect configuration.
168170

171+
- Should you use [VIATRA](https://www.eclipse.org/viatra/) in Eclipse in any project, do not forget to set the folder into which VIATRA generates the Java classes. To do so go to `Window -> Preferences -> VIATRA -> Query Language -> Compiler` and set the `Output Folder / Directory` for `./src/main/vql-gen`. After that, set that folder as a source folder of the project and exclude it from the .gitignore file in the project folder: write `!/src/main/vql-gen/*` in the .gitignore file. However, this last step might be unnecessary if there is a VIATRA compiler available as a gradle plugin. (As of writing these lines, it is done available yet.)
172+
169173
- Should you have build problems in Eclipse with Xtend, check if there is a `build/xtend/main` and `build/xtend/test` folders in the project. If so, remove the folders. In addition to that, remove the ` <classpathentry kind="src" path="build/xtend/main"/>
170174
<classpathentry kind="src" path="build/xtend/test"/>` lines from the `.classpath` file in the corresponding project.
175+
176+
- Never combine Xtend and pure Java files in the same source folder, because the Xtend / Xtext Compiler's Gradle plugin will get crazy and either end up in a stack overflow exception or show error markers at references for java classes in xtend files.
171177

172178
- Should some change notifications from the file system not arrive to Eclipse, don't forget to use the 'good old' right click on the project name -> Refresh project option. Restarting Eclipse might also solve problems sometimes.

0 commit comments

Comments
 (0)