nl.irias.sherpa

Class SherpaDocHelper

java.lang.Object

nl.irias.sherpa.SherpaDocHelper

public abstract class SherpaDocHelper
extends Object

SherpaDocHelper makes it easy to add information about types used in functions to your sherpa documentation.

Constructor Summary

Constructors

Constructor and Description
SherpaDocHelper()

Method Summary

Modifier and Type	Method and Description
static void	describeData(SherpaDoc doc, String sectionName, Class<?>... classes) DescribeData will lookup "sectionName" in the sherpa documentation "doc" (which you must have parsed before hand).
static SherpaDoc	getDoc(SherpaDoc doc, String sectionName)

Methods inherited from class java.lang.Object

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

Constructor Detail

SherpaDocHelper

public SherpaDocHelper()

Method Detail

describeData

public static void describeData(SherpaDoc doc,
                                String sectionName,
                                Class<?>... classes)
                         throws Exception

DescribeData will lookup "sectionName" in the sherpa documentation "doc" (which you must have parsed before hand). It adds type information for all "classes": It shows lists all public fields, found through reflection.

Throws:

Exception

getDoc

public static SherpaDoc getDoc(SherpaDoc doc,
                               String sectionName)