org.eclipse.eclipsecon
Class TalkAbstract

java.lang.Object
  org.eclipse.eclipsecon.TalkAbstract

public class TalkAbstract
extends java.lang.Object

Nested Class Summary

class	TalkAbstract.Attendee A person who is going to be (or is) at EclipseCon
static class	TalkAbstract.Information Useful bits that will be passed from a TalkAbstract.Speaker to a TalkAbstract.Attendee
class	TalkAbstract.Speaker Instance of a person with some specialized knowledge, or TalkAbstract.Information that can be considered valuable or useful to an TalkAbstract.Attendee at EclipseCon or some other presentation.

Constructor Summary

TalkAbstract()

Method Summary

(package private) TalkAbstract.Information

javaDocTalk(TalkAbstract.Speaker speaker, java.util.ArrayList<TalkAbstract.Attendee> audience)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TalkAbstract

public TalkAbstract()

Method Detail

javaDocTalk

TalkAbstract.Information javaDocTalk(TalkAbstract.Speaker speaker,
                                     java.util.ArrayList<TalkAbstract.Attendee> audience)

The Eclipse Javadoc viewer includes a powerful HTML renderer and viewer. This allows traditional Javadoc comments to include simple decorations such as Bold and Italics. However with a little bit of creativity and work, more advanced javadoc comments are possible. For example, external images can be embedded to illustrate how methods work.

A developer may consider linking to Bugzilla to help users track and report issues found with an under-development project, or give an e-mail address for the same purpose.

In this talk I will show approximately different ways to create interactive, dynamic and generally interesting Javadoc comments; discuss the limitations of the HTML browser; and invite the Eclipse Community to come up with more new ways to maximize Javadoc usage.

Parameters:

speaker - TalkAbstract.Speaker The person who is going to deliver this talk

audience - TalkAbstract.Attendee those attending this talk hoping to learn new ways of using JavaDoc.

Returns:

A new way of looking at and creating Javadoc comments