Instadoc
Reads annotated Java code and collects the inserted documentation and creates a summery.
Installation
Add this line to your application's Gemfile:
gem 'instadoc'
And then execute:
$ bundle
Or install it yourself as:
$ gem install instadoc
Usage
$instadoc -s /path/to/source html -o output.html -l http://server/path/PLACEHOLDER
Use the upper case string PLACEHOLDER
is a placeholder for package and Java file name.
The placeholder will be created by the relative path from the given source path -s /path/to/source
as a base path and the Java file itself.
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Added some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request