av.util
Class DocCommentParser

java.lang.Object
  av.util.DocCommentParser

public class DocCommentParser
extends Object

This class parses java doc comments into main doc and doc tag separated descriptions.

SUN Java compiler will supply the doc comment with /** and line leading * and */ removed, while current Eclipse compiler will keep them. This class tries to be tolerant enough for those differences.

Author:

Compl

Field Summary

String	mainDoc
Pair<String,String>[]	tags

Constructor Summary

DocCommentParser(String doc)

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

mainDoc

public final String mainDoc

tags

public final Pair<String,String>[] tags

Constructor Detail

DocCommentParser

public DocCommentParser(String doc)