You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+2-62Lines changed: 2 additions & 62 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,66 +20,6 @@ To run the plugin:
20
20
In this version, the core of the plugin is based on [SRCML](http://www.srcml.org/). In essence, the source-code of the project is encoded in an XML file. This XML file is then processed via XPath queries for different rules. The main XML file is a variable in the plugin code and is not accessible out of it. However, the temporary process results are written in files in the project folder. Removing these files are safe.
21
21
22
22
23
-
## ruleJson.txt
23
+
## ruleJson.txt and tagJson.txt
24
24
25
-
There must be a file name `ruleJson.txt` in the project folder. In this file, there exists a JSON object named `ruleTable`. Here is the example for this file:
26
-
27
-
```
28
-
[
29
-
{
30
-
"ruleDescription": "All classes must have a constructors",
"ruleDescription": "All @Entity classes must be registered.",
46
-
"detail": "All @Entity classes must register themselves so that they can be used with Objectify. You need the statement ObjectifyService.register(TheEntityClassInQuestion);",
There is also another json file named `tagJson.txt`. In this file we store information
70
-
about tags. Here is an example for this file:
71
-
72
-
```
73
-
[
74
-
{
75
-
"tagName": "class",
76
-
"detail": "detail about tag 'class'"
77
-
},
78
-
{
79
-
"tagName": "constructor",
80
-
"detail": "detail about tag 'constructor'"
81
-
}
82
-
]
83
-
```
84
-
85
-
The format of this file is not final.
25
+
There must be two files named `ruleJson.txt` and `tagJson.txt` in the project folder. The example for these files can be found in `README.md` in **active-doc-client** repository.
0 commit comments