Skip to content

epicdevs/better-javadoc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 

Repository files navigation

better-javadoc

better-javadoc makes javadocs as commentable documents. Each package and class has its own separate commenting thread so people can post questions and discussions directly on the related javadoc.

JDK Support

Currently I only tested it to javadocs generated with JDK 1.7.

Demo

http://epicdevs.github.io/better-javadoc-example/

HOW-TO

1. Copy files

  • Copy better-javadoc.js and better-javadoc.css to the javadoc directory.

2. Configure better.py

  • Modify href and src of variable rep to a proper path so that each html can access better-javadoc.js and better-javadoc.css when uploaded on the server.

3. Configure better-javadoc.js

  • Change disqus_shortname to your own disqus site name.

4. Run better.py

python better.py javadoc-directory

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published