Skip to content

winterbe/javadoc-reloaded

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

43 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.

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.

About

Proposal for JEP 225: Javadoc Search

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors