# javadoc

**Repository Path**: awesomecode/javadoc

## Basic Information

- **Project Name**: javadoc
- **Description**: gitbook生成工具
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2018-01-11
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 一个自动生成接口文档的工具
#快要残了，现在开源

功能介绍
	
> 根据javadoc 自动生成gitbook文档

使用方法：

1.安装gitbook 安装方法[https://blog.javanx.com/2018/01/15/install-gitbook/](https://blog.javanx.com/2018/01/15/install-gitbook/)


2.导入jar 包，请自行下载源码打包到本地maven库

    <dependency>
			  <groupId>com.bx</groupId>
			  <artifactId>javadoc</artifactId>
			  <version>0.0.2</version>
		</dependency>


3.新建类编写main方法

 	public static void main(String[] args) {
		
		Config cfg=new Config("E:\\workspace\\xiaoheixiong\\testjavadoc\\src\\main\\java\\com\\bx\\testjavadoc\\domain"
				,"E:\\workspace\\xiaoheixiong\\testjavadoc\\src\\main\\java\\com\\bx\\testjavadoc\\controller",
				"E:\\workspace\\xiaoheixiong\\testjavadoc\\src\\main\\java\\com\\bx\\testjavadoc\\controller\\api");
		DOCCenterController.generatorGitBookJavaDoc(cfg);
	}
> config 第一个参数是pojo的路径，
> 第二个参数是要生成接口文档的controller的java类路径
> 第三个参数是接口文档的生成路径

4.运行main方法


5.打开cmd 命令行进入 接口文档的生成目录下  
也就是`f:\\apiDoc` 下
执行：

    gitbook serve

6.访问[http://localhost:4000](http://localhost:4000)


7.效果图
![](https://i.imgur.com/DyyWsnI.jpg)

![](https://i.imgur.com/jYHzsbg.png)

![](https://i.imgur.com/C68PHd4.png)

![](https://i.imgur.com/UYzF3bT.png)




9.查看详细教程

    待更新