Skip to content

Commit c6b76b0

Browse files
Update README.md
1 parent efe5c65 commit c6b76b0

1 file changed

Lines changed: 2 additions & 62 deletions

File tree

README.md

Lines changed: 2 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -20,66 +20,6 @@ To run the plugin:
2020
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.
2121

2222

23-
## ruleJson.txt
23+
## ruleJson.txt and tagJson.txt
2424

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",
31-
"detail": "No detail.",
32-
"quantifierXpath": "//src:class",
33-
"quantifierTitle": "All classes",
34-
"quantifierXpathName": "//src:class/src:name/text()",
35-
"conditionedTitle": "Classes with constructors",
36-
"conditionedXpath": "//src:class[count(src:block/src:constructor)>0]",
37-
"conditionedXpathName": "//src:class[count(src:block/src:constructor)>0]/src:name/text()",
38-
"tags": [
39-
"class",
40-
"constructor"
41-
],
42-
"index": 1
43-
},
44-
{
45-
"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);",
47-
"quantifierXpath": "//src:class[src:annotation/src:name/text()=\"Entity\"]",
48-
"quantifierXpathName": "//src:class[src:annotation/src:name/text()=\"Entity\"]/src:name/text()",
49-
"quantifierTitle": "All @Entity classes",
50-
"conditionedXpath": "//src:call[src:name//text()=\"register\"]",
51-
"conditionedXpathName": "//src:call[src:name//text()=\"register\"]/src:argument_list//src:name[position()=1]/text()",
52-
"conditionedTitle": "Registered classes",
53-
"tags": [
54-
"class",
55-
"annotation",
56-
"entity",
57-
"register",
58-
"function"
59-
],
60-
"index": 2
61-
}
62-
]
63-
```
64-
65-
The format of this file is not final.
66-
67-
## tagJson.txt
68-
69-
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

Comments
 (0)