Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 2e9df32

Browse files
committed
back
1 parent 7b02611 commit 2e9df32

File tree

16 files changed

+334
-156
lines changed

16 files changed

+334
-156
lines changed

‎build.gradle‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,19 @@ version '1.0-SNAPSHOT'
88
sourceCompatibility = 1.8
99

1010
repositories {
11-
mavenCentral()
11+
// using the local
12+
if (project.version.endsWith('-SNAPSHOT')) {
13+
mavenLocal()
14+
}
15+
else {
16+
mavenCentral()
17+
}
18+
1219
}
1320

1421
dependencies {
1522
testCompile group: 'junit', name: 'junit', version: '4.12'
1623
compile 'com.google.guava:guava:27.1-jre'
1724
compileOnly "org.projectlombok:lombok:1.16.16"
18-
implementation 'com.github.javaparser:javaparser-symbol-solver-core:3.14.3'
25+
implementation 'com.github.javaparser:javaparser-symbol-solver-core:3.14.4-SNAPSHOT'
1926
}

‎readme.md‎

Lines changed: 41 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,28 +22,61 @@ The man reason is that i want a easy and non-invasive tool.
2222

2323
## how to use ?
2424

25-
### generate Html
2625

27-
```java
2826

27+
### Java Doc Standard
2928

29+
### method
3030

31-
```
31+
- `@param` : the parameter of method
32+
- `@return` : the return info
3233

33-
### generate json
3434

35-
```java
3635

37-
```
36+
### Extend Java Doc
37+
38+
#### `@necessary`:
39+
> The parameter is necessary or not for current method ;
40+
41+
- `ethod`
42+
43+
#### `@ignore`:
44+
> The filed or the method will be ignore or not ;
45+
46+
- `Field`,`Class`,`Method` ,`Parameter`
47+
48+
In filed:
3849

39-
### sync api to YApi
4050

4151
```java
4252

53+
// line tag
54+
/**
55+
* @ignore
56+
* /
57+
private int number;
58+
59+
// inline tag
60+
/**
61+
* @param {@ignore} {@fuzzy}
62+
*/
63+
4364
```
4465

4566

4667

68+
69+
70+
#### `@name`
71+
> the name of current entity(contains class,method )
72+
- `Method`,`class`
73+
74+
75+
## TODO LIST
76+
77+
- Extend the Java doc
78+
79+
4780

4881
## Reference
4982

@@ -55,4 +88,4 @@ dependencies:
5588

5689
- git hook
5790

58-
- mock
91+
- [java doc](https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html)
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
package com.hsjfans.github.generator;
2+
3+
/**
4+
* @author hsjfans[hsjfans.scholar@gmail.com]
5+
*/
6+
public class BSonGenerator {
7+
}
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
package com.hsjfans.github.generator;
2+
3+
/**
4+
* @author hsjfans[hsjfans.scholar@gmail.com]
5+
*/
6+
public class JsonGenerator {
7+
}

‎src/main/java/com/hsjfans/github/model/Api.java‎

Lines changed: 0 additions & 40 deletions
This file was deleted.

‎src/main/java/com/hsjfans/github/model/Comment.java‎

Lines changed: 0 additions & 33 deletions
This file was deleted.

‎src/main/java/com/hsjfans/github/model/Constant.java‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55
*/
66
public class Constant {
77

8+
/**
9+
* the request method
10+
*/
811
public static enum RequestMethod{
912
GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS, TRACE
1013
}
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
package com.hsjfans.github.model;
2+
3+
import java.io.Serializable;
4+
5+
/**
6+
* @author hsjfans[hsjfans.scholar@gmail.com]
7+
*/
8+
public class ControllerClass implements Serializable {
9+
10+
/**
11+
* the class name `@name`
12+
*/
13+
private String name;
14+
15+
/**
16+
* the description
17+
*/
18+
private String description;
19+
20+
/**
21+
* the base url `@RequestMapping(value="/books")`
22+
*/
23+
private String url;
24+
25+
26+
/**
27+
* the methods
28+
*/
29+
@Deprecated
30+
private Constant.RequestMethod[] methods;
31+
32+
33+
}
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
package com.hsjfans.github.model;
2+
3+
import java.io.Serializable;
4+
import java.lang.reflect.Method;
5+
6+
/**
7+
* @author hsjfans[hsjfans.scholar@gmail.com]
8+
*/
9+
public class ControllerMethod implements Serializable {
10+
11+
12+
/**
13+
* is true will be ignored
14+
*/
15+
private boolean ignore;
16+
17+
/**
18+
*
19+
* the method url
20+
*/
21+
private String url;
22+
23+
/**
24+
* the method name `@name`
25+
**/
26+
private String name;
27+
28+
29+
/**
30+
* the method
31+
*/
32+
private Method method;
33+
34+
/**
35+
* the description
36+
*/
37+
private String description;
38+
39+
/**
40+
* the class
41+
*/
42+
private Class<?> aClass;
43+
44+
/**
45+
* the args
46+
*/
47+
private RequestParam[] params;
48+
49+
50+
/**
51+
* the responseReturn
52+
*/
53+
private ResponseReturn responseReturn;
54+
55+
56+
/**
57+
* the request that api support
58+
*/
59+
private Constant.RequestMethod[] methods;
60+
61+
62+
}

‎src/main/java/com/hsjfans/github/model/RequestEntiry.java‎

Lines changed: 0 additions & 10 deletions
This file was deleted.

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /