命令行调用

wrdoclet支持的传入参数主要有:

参数名 含义
-dubboconfigpath <path> 可选。dubbo服务的配置文件路径,参见“dubbo使用说明”章节
-springcontextconfigpath <path> 可选。spring服务的配置文件路径,参见“Spring MVC使用说明”章节
-excludedurlsxpath <path> 可选。用于识别登录验证URL的xpath,参见“Spring MVC使用说明”章节
-branchname <branchname> branchname和codeurl两则必须有其一。代码分支名称
-codeurl <codeurl> branchname和codeurl两则必须有其一。代码路径URL。当参数未指定branchname时,自动将codeurl的最后一段作为branchname。主要是方便使用SVN的jenkins用户,比如http://127.0.0.1/demobubbo/branches/2016.1.1release/ 使用代码路径url,避免新增branch时需要修改参数。
-systemname <systemname> 必须。系统名称
-searchengine <url> 可选。solr搜索引擎的地址
-buildid <buildid> 可选。标识本次运行的ID,如果未指定或者为"time"时以系统时间作为ID。主要用于和jenkins集成时确保推送到solr的文档是当次运行输出的文档。

以及javadoc和标准doclet原生的参数有:

参数名 含义
-d <directory> 输出文件的目标目录
-charset <charset> 用于跨平台查看生成的文档的字符集
-doclet <class> 通过替代 doclet 生成输出
-docletpath <path> 指定查找 doclet 类文件的位置
-sourcepath <pathlist> 指定查找源文件的位置
-classpath <pathlist> 指定查找用户类文件的位置
-encoding <name> 源文件编码名称
-nodeprecated 不包含 @deprecated 信息
-taglet 要注册的 Taglet 的全限定名称
-tagletpath Taglet 的路径

通过命令行生成接口文档比较麻烦,需要在命令中指定所需的jar包路径,不推荐使用。下面是命令行生成接口文档的例子:

set jarpath=C:\Users\AdamsLee\.m2\repository
javadoc -doclet net.winroad.wrdoclet.HtmlDoclet -docletpath D:\Git\wrdoclet\wrdoclet\target\wrdoclet-1.0.0-SNAPSHOT.jar;%jarpath%\javax\servlet\servlet-api\2.5\servlet-api-2.5.jar;%jarpath%\org\springframework\spring-web\3.2.2.RELEASE\spring-web-3.2.2.RELEASE.jar;%jarpath%\org\springframework\spring-core\3.2.2.RELEASE\spring-core-3.2.2.RELEASE.jar;%jarpath%\org\slf4j\slf4j-api\1.7.5\slf4j-api-1.7.5.jar;%jarpath%\junit\junit\3.8.1\junit-3.8.1.jar;%jarpath%\com\google\code\gson\gson\2.3.1\gson-2.3.1.jar;%jarpath%\commons-io\commons-io\2.4\commons-io-2.4.jar;%jarpath%\commons-lang\commons-lang\2.5\commons-lang-2.5.jar;%jarpath%\org\freemarker\freemarker\2.3.19\freemarker-2.3.19.jar;%jarpath%\ch\qos\logback\logback-classic\1.0.3\logback-classic-1.0.3.jar;%jarpath%\ch\qos\logback\logback-core\1.0.3\logback-core-1.0.3.jar;%jarpath%\org\slf4j\slf4j-api\1.7.5\slf4j-api-1.7.5.jar;%jarpath%\org\slf4j\slf4j-jdk14\1.5.6\slf4j-jdk14-1.5.6.jar;%jarpath%\org\slf4j\slf4j-log4j12\1.7.5\slf4j-log4j12-1.7.5.jar;%jarpath%\javax\servlet\servlet-api\2.5\servlet-api-2.5.jar;%jarpath%\com\yahoo\platform\yui\yuicompressor\2.4.8\yuicompressor-2.4.8.jar;%jarpath%\org\springframework\spring-webmvc\3.2.2.RELEASE\spring-webmvc-3.2.2.RELEASE.jar;%jarpath%\org\springframework\spring-context\4.0.6.RELEASE\spring-context-4.0.6.RELEASE.jar -classpath %jarpath%\javax\servlet\servlet-api\2.5\servlet-api-2.5.jar;%jarpath%\org\springframework\spring-context\4.0.6.RELEASE\spring-context-4.0.6.RELEASE.jar;%jarpath%\javax\servlet\servlet-api\2.5\servlet-api-2.5.jar;%jarpath%\org\springframework\spring-web\3.2.2.RELEASE\spring-web-3.2.2.RELEASE.jar;%jarpath%\org\springframework\spring-core\3.2.2.RELEASE\spring-core-3.2.2.RELEASE.jar -taglet net.winroad.wrdoclet.taglets.WRTagTaglet net.winroad.wrdoclet.taglets.WRMemoTaglet net.winroad.wrdoclet.taglets.WRReturnCodeTaglet -encoding utf-8 -charset utf-8 -sourcepath D:\Git\wrdoclet\wrdoclet-demosite\src\main\java org.springframework.web.bind.annotation net.winroad.Controller -d D:\Git\gendoc -systemname demosite -branchname release

results matching ""

    No results matching ""