Annotation to cappture javadoc

Annotation to cappture javadoc

• Introduction
• Download
• Source code

References

• Javadoc

Project Documentation

• Project Information
  • About
  • Continuous Integration
  • Dependencies
  • Distribution Management
  • Issue Tracking
  • Mailing Lists
  • Plugin Management
  • Project License
  • Project Plugins
  • Project Summary
  • Project Team
  • Source Repository
• Project Reports

This little library defines CaptureJavadoc annotation that causes Java compiler to record Javadoc in resoures files (if your class is org.acme.Foo the javadoc will be in org/acme/Foo.javadoc. These files can be then read at runtime.

package org.acme;

import org.kohsuke.CaptureJavadoc;

@CaptureJavadoc
class Foo {
  ...

  public URL getMyJavadoc() {
    return getClass().getResource("Foo.javadoc");
  }
}

The annotation processing depends on JSR-269, so it requires Java6 or later.