org.arl.fjage.shell

Class Documentation

java.lang.Object

org.arl.fjage.shell.Documentation

public class Documentation
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<java.lang.String>	doc
protected java.util.regex.Pattern	heading
protected java.util.Map<java.lang.String,java.lang.Integer>	ndx
protected java.util.regex.Pattern	section

Constructor Summary

Constructors

Constructor and Description
Documentation()

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String s) Add markdown documentation.
java.lang.String	get() Get documentation index.
java.lang.String	get(java.lang.String keyword) Get documentation by keyword.
java.lang.String	search(java.lang.String keyword) Search documentation topics by keyword.

Methods inherited from class java.lang.Object

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

Field Detail

doc

protected java.util.List<java.lang.String> doc

ndx

protected java.util.Map<java.lang.String,java.lang.Integer> ndx

heading

protected java.util.regex.Pattern heading

section

protected java.util.regex.Pattern section

Constructor Detail

Documentation

public Documentation()

Method Detail

add

public void add(java.lang.String s)

Add markdown documentation.

Parameters:

s - multiline string.

get

public java.lang.String get()

Get documentation index.

search

public java.lang.String search(java.lang.String keyword)

Search documentation topics by keyword.

Parameters:

keyword - keyword.

get

public java.lang.String get(java.lang.String keyword)

Get documentation by keyword.

Parameters:

keyword - keyword.