GitHub user takuti opened a pull request:
https://github.com/apache/incubator-hivemall/pull/148
[HIVEMALL-193] Implement a tool for generating a list of Hivemall UDFs
## What changes were proposed in this pull request?
Automatically generate a list of UDFs for:
- https://hivemall.incubator.apache.org/userguide/misc/funcs.html
- https://hivemall.incubator.apache.org/userguide/misc/generic_funcs.html
Initial mock implementation: https://github.com/takuti/hivemalldoc
## What type of PR is it?
Improvement, Documentation
## What is the Jira issue?
https://issues.apache.org/jira/browse/HIVEMALL-193
## How was this patch tested?
See output: https://gist.github.com/takuti/312d3a11bf85fc4044399d7e97a06f13
## How to use this feature?
```
$ mvn clean package -Dskiptests=true -Dmaven.test.skip=true
$ java -jar
target/hivemall-tool-docs-0.5.1-incubating-SNAPSHOT-with-dependencies.jar
```
## Checklist
- [x] Did you apply source code formatter, i.e., `mvn formatter:format`,
for your commit?
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/takuti/incubator-hivemall HIVEMALL-193
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/incubator-hivemall/pull/148.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #148
----
commit d5cc360bda79cbe51619d9063415c35b854295ba
Author: Takuya Kitazawa <k.takuti@...>
Date: 2018-04-20T07:38:28Z
Add documentation assistance tool initial code
commit fe86ae479dab12ddcd82682daf9cc0905ff562ad
Author: Takuya Kitazawa <k.takuti@...>
Date: 2018-04-20T08:20:05Z
Use StringUtils in hivemall-core
commit 412e514a9b0df9ccfc420e14182d4084321078eb
Author: Takuya Kitazawa <k.takuti@...>
Date: 2018-04-20T08:21:40Z
Main class name should be same as project name
commit 534a8393d66d805eb158b8795071ca864543a31f
Author: Takuya Kitazawa <k.takuti@...>
Date: 2018-04-20T08:34:02Z
Change class path: hivemall.tool.docs -> hivemall.docs
hivemall.tool is very similar to hivemall.tools (in hivemall-core) and
confusing.
commit a7e2436c400f168291baa3203af89de2d2080da6
Author: Takuya Kitazawa <k.takuti@...>
Date: 2018-04-23T01:56:06Z
Print based on pre-defined Markdown headers
commit c04f8bd7757a1d7cd33b1c82ec7e858737f65eb3
Author: Takuya Kitazawa <k.takuti@...>
Date: 2018-04-23T02:23:41Z
Add extended descriptions to generic UDFs
commit a8981f8c03d4943226807110dfde895713a51001
Author: Takuya Kitazawa <k.takuti@...>
Date: 2018-04-23T02:53:19Z
Change how to handle newline in @Description(value) annotation
commit 2cec989bb39d8d9d99fd60991a0bb9a66cd67139
Author: Takuya Kitazawa <k.takuti@...>
Date: 2018-04-23T03:05:06Z
Format
----
---
