virtualsatellite
VirSat Core Developer Manual Improvements
While working through the VirSat Core Developer Manual I found the following points, which could be improved (in no particular order):
-
In the header the current chapter should be displayed
-
A hint that Virtual Satellite should be extracted in a top level folder in windows, because the path of some files might get too long
-
For people using eclipse for the first time, there is no information about the workspace selection window
-
Like shown in the picture the concrete Project (in this case Virtual Sattelite 4 Core) could be mentioned
-
Since there are a seperate target configuration for windows and linux, this could be also mentioned in the docs. Also that "Set active Target Platform" has to be pressed should be mentioned. See here
-
Typo: See here It should be possible to open
-
"Contains a reference to a Category Assignment or in the model" I think the "or" can be removed or there is something missing after the "or" See here
-
Somewhere it should be mentioned, that Structural Elements have to be defined before the Categories. Otherwise you get a error message, that "}" is expected when defning a Structural Element after a Category. Maybe even the error message/validator could be improved here.
-
There is information missing on how to debug a Virtual Satellite instance with the concepts developed in the IDE
-
In the test case example the plugin ID can be retrieved via
<packagepath>.getPluginId(). The example used hardcoded strings. The best practise with the method should be demonstrated. -
A short description where exactly own test cases should be added would be nice
-
Typo "definded" in the test case example
-
The test case is not ready to use, some lines are missing and it does not compile
-
Own plugins are created in the workspace folder, which is not version controlled. It should be describes, how to put an own plugin under version control
-
Add a description on how to check if the Java API Doc has been updated
CEF
When using the CEF version, it is not described if a normal eclipse or Virsat IDE should be used
I will update this issue with more improvement ideas in the near future.
