Proposal for JEP 225: Javadoc Search
CSS Java JavaScript
Latest commit d135acf Dec 8, 2014 @winterbe Merge pull request #3 from meistermeier/patch-1
Fix slicing result set
Permalink
Failed to load latest commit information.
src/main Fix slicing result set Dec 6, 2014
.gitignore
LICENSE
README.md
pom.xml Fixed indentation, origin repo uses 4 spaces Nov 24, 2014

README.md

Javadoc Reloaded

The Javadoc Reloaded project transforms arbitrary Javadoc API folders into fully fledged searchable webapps from the 21st century. It's a proposal for JEP 225 crafted by Benjamin Winterberg.

http://winterbe.com/projects/javadoc-reloaded/javase/8/api/

Compatibility

The tool is written in Java 8 and built with Maven 3. The frontend is tested and optimized for current desktop browser versions (Chrome, Firefox, Safari). If you find any issues related to Internet Explorer or other browsers, please let me know.

Known issues

The frontend is currently missing keyboard navigation through search results. It's also not optimized for mobile browsers at the moment. This may be subject to future work. Just send me your feedback about missing features or bugs by opening an issue.

Contribute

Feel free to fork this project and send me pull requests. You can also send me feedback via Twitter or by opening an issue.

License

The source code is published under the MIT license. If you reuse the code for your own javadoc transformations please preserve information about me as original author in the about dialog.