|
||||||||||
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.XQDoc
public final class XQDoc
This class contains functions for generating a xqDoc documentation.
Field Summary |
---|
Fields inherited from class org.basex.query.util.inspect.Inspect |
---|
ctx, info, module |
Constructor Summary | |
---|---|
XQDoc(QueryContext qc,
InputInfo ii)
Constructor. |
Method Summary | |
---|---|
protected FElem |
elem(java.lang.String name,
FElem parent)
Creates an element. |
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. |
protected void |
type(SeqType st,
FElem parent)
Creates a type element. |
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 XQDoc(QueryContext qc, InputInfo ii)
qc
- query contextii
- input infoMethod Detail |
---|
public FElem parse(IO io) throws QueryException
Inspect
parse
in class Inspect
io
- input reference
QueryException
- query exceptionprotected FElem elem(java.lang.String name, FElem parent)
Inspect
elem
in class Inspect
name
- name of elementparent
- parent element
protected FElem tag(byte[] tag, FElem parent)
Inspect
tag
in class Inspect
tag
- tagparent
- parent element
protected void type(SeqType st, FElem parent)
st
- sequence typeparent
- parent node
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |