|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.basex.query.util.inspect.Inspect
org.basex.query.util.inspect.PlainDoc
public final class PlainDoc
This class contains functions for generating a plain XQuery documentation.
Field Summary |
---|
Fields inherited from class org.basex.query.util.inspect.Inspect |
---|
ctx, info, module |
Constructor Summary | |
---|---|
PlainDoc(QueryContext qc,
InputInfo ii)
Constructor. |
Method Summary | |
---|---|
FElem |
context()
Parses a module and returns an inspection element. |
protected FElem |
elem(java.lang.String name,
FElem parent)
Creates an element. |
FElem |
function(QNm fname,
StaticFunc sf,
FuncType ftype,
FElem parent)
Creates a description for the specified function. |
FElem |
parse(IO io)
Parses a module and returns an inspection element. |
protected FElem |
tag(byte[] tag,
FElem parent)
Creates a new element for the specified tag. |
Methods inherited from class org.basex.query.util.inspect.Inspect |
---|
add, annotation, comment, doc, parseQuery |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PlainDoc(QueryContext qc, InputInfo ii)
qc
- query contextii
- input infoMethod Detail |
---|
public FElem context() throws QueryException
QueryException
- query exceptionpublic FElem parse(IO io) throws QueryException
Inspect
parse
in class Inspect
io
- input reference
QueryException
- query exceptionpublic FElem function(QNm fname, StaticFunc sf, FuncType ftype, FElem parent) throws QueryException
fname
- name of functionsf
- function referenceftype
- function typeparent
- node
QueryException
- query exceptionprotected FElem elem(java.lang.String name, FElem parent)
elem
in class Inspect
name
- name of elementparent
- parent node
protected FElem tag(byte[] tag, FElem parent)
Inspect
tag
in class Inspect
tag
- tagparent
- parent element
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |