[shiro学习笔记]第四节 使用源代码生成Shiro的CHM格式的API文档

来源:互联网 发布:中文数据库 编辑:程序博客网 时间:2024/05/01 05:27

版本为1.2.3的shiro API chm个事故文档生成。

    • 获取shiro源代码
    • 编译生成API文档
    • 转换成chm格式 API

获取shiro源代码

shiro官网: http://shiro.apache.org/
下载源代码资源包,使用myeclipse/eclipse将代码加入工程中。如:
shiro源代码
需要使用到的jar包:
jar包

编译生成API文档

Created with Raphaël 2.1.2项目Export选择java下的javadoc选择要导出的工程java doc的配置设置结束

这里写图片描述
这里写图片描述
这里写图片描述
这里写图片描述

转换成chm格式 API

下载 javadoc2chm
转换非常简单,安装 javadoc2chm.1.3.1.11.msi 之后,启动,选择index.html文件,输入生成的文件名称和标题。

这里写图片描述
故,现在新版本的docs文件均可以顺利生成chm格式api文档了。
其他可以使用的javadoctochm工具推荐:
1. http://jan.baresovi.cz/dr/en/javadoc-chm
2. http://javadoc2help.sourceforge.net/
3. http://www.burgaud.com/jd2chm/

1 0