Documentation and Javadoc TODOs

[JonathanMace]

README markdowns in root and project subdirs:

• Readmes for root project and all subprojects. Figure out appropriate way of presenting the information.
• Tracingplane organization documentation
• Directory of resources (wiki pages, javadocs, package docs)

Javadocs

• Package level documentation
• Docs on all public classes
• Fold some of the package doc README info into javadocs too

Wiki pages

• One of several pages outlining researchy parts of tracing plane, mostly pulled from paper
• High level overview of how to use tracingplane
• Tutorial: Downloading / cloning / building / installing
• Tutorial: set up a maven project or add jar to classpath
• Tutorial: instrumenting a system (threads, runnables, callables); instrumenting a system (custom queues); instrumenting a system (network / io); advanced: using aspectj
• FAQ page: what is the license? do you have systems instrumented already that i can plug in to? is it compatible with scala?

Other Project TODOs:

• Make download links for distribution JARs with dependencies
• Make license explicit somewhere
• For distribution JARs, enumerate all dependencies and their licenses
• Split out BDL compiler to separate project
• Fix scala versions