[refactor] adjust directory architecture of doclet

调整doclet的目录结构

Author: jingkaimori

docgen/bitrxc-doclet/README.md docgen/README.md

@@ -1,7 +1,4 @@
-
-
-
-   bitrxc-doclet
+bitrxc-doclet
 ===========================
 
 Introduction
@@ -10,21 +7,18 @@ This java doclet allows for auto generation of  API documentation that can be re
 
 It is modified from [calrissian/rest-doclet: Automatic generation of REST documentation from Spring and JAX-RS Controllers. (github.com)](https://github.com/calrissian/rest-doclet).
 
-
-
-Example of API documentation 
-----------------------------
-The API documentation of bitrxc-server-dev is at
-bitrxc-doclet\example\bitrxc-server-dev\service\target\site\apidocs
-
-
-
-
 How to generate API documentation from a Spring project
 ----------------------------
-If you want to use it in your Spring project, copy the folder "bitrxc-doclet\generated doclet\cn\edu\bit\ruixin\bitrxc-doclet"  to your Maven local repository. And then follow these steps
+If you want to use it in your Spring project, follow these steps:
+
+1.  Install
+Enter following command under the root path of this project("bitrxc-doclet") 
+  ```
+  mvn clean install
+  ```
+Then the doclet is generated in your Maven local repository. The groupId is "cn.edu.bit.ruixin.rest-doclet"
 
-1.  Maven
+2.  Maven
 Configure the javadoc plugin to use this custom doclet. To be specific, add the following xml to your Maven configuration file 
   ```xml
     <build>
@@ -39,9 +33,9 @@ Configure the javadoc plugin to use this custom doclet. To be specific, add the
                     <encoding>UTF-8</encoding>
                     <useStandardDocletOptions>false</useStandardDocletOptions>
                     <show>private</show>
-                    <doclet>cn.edu.bit.ruixin.doc.RestDoclet</doclet>
+                    <doclet>cn.edu.bit.ruixin.doclet.restful.RestDoclet</doclet>
                     <docletArtifact>
-                        <groupId>cn.edu.bit.ruixin.bitrxc-doclet</groupId>
+                        <groupId>cn.edu.bit.ruixin</groupId>
                         <artifactId>rest-doclet</artifactId>
                         <version>1.0-SNAPSHOT</version>
                     </docletArtifact>
@@ -51,35 +45,16 @@ Configure the javadoc plugin to use this custom doclet. To be specific, add the
     </build>
 
   ```
-2.  Command
+3.  Command
 Enter the following command under your project path
   ```
   mvn javadoc:javadoc
   ```
 
-3.  Result
+4.  Result
     Then the API document index.html and stylesheet.css is generated at target/site/apidocs
 
-
-
-Example to generate API documentation from a Spring project
-----------------------------
-
-1. Copy the folder "bitrxc-doclet\generated doclet\cn\edu\bit\ruixin\bitrxc-doclet"  to your local Maven repository.
-
- 2.Enter the following command under the path bitrxc-doclet\example\bitrxc-server-dev
-
-  ```
-  mvn javadoc:javadoc
-  ```
-Then the documentation is generated at bitrxc-doclet\example\bitrxc-server-dev\service\target\site\apidocs
-
-
-How to generate doclet from source code
+How to build doclet from source code
 ----------------------------
-If you want to modify the doclet source code and generate doclet from source code, just enter following command under the root path of this project("bitrxc-doclet") 
-  ```
-  mvn clean install
-  ```
-Then the doclet is generated in your Maven local repository. The groupId is "cn.edu.bit.ruixin.bitrxc-doclet"
 
+If you want to modify the doclet source code and generate doclet from source code, just