org.basex.query.util.inspect
Class XQDoc

java.lang.Object
  extended by org.basex.query.util.inspect.Inspect
      extended by org.basex.query.util.inspect.XQDoc

public final class XQDoc
extends Inspect

This class contains functions for generating a xqDoc documentation.

Author:
BaseX Team 2005-13, BSD License, Christian Gruen

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

XQDoc

public XQDoc(QueryContext qc,
             InputInfo ii)
Constructor.

Parameters:
qc - query context
ii - input info
Method Detail

parse

public FElem parse(IO io)
            throws QueryException
Description copied from class: Inspect
Parses a module and returns an inspection element.

Specified by:
parse in class Inspect
Parameters:
io - input reference
Returns:
inspection element
Throws:
QueryException - query exception

elem

protected FElem elem(java.lang.String name,
                     FElem parent)
Description copied from class: Inspect
Creates an element.

Specified by:
elem in class Inspect
Parameters:
name - name of element
parent - parent element
Returns:
element node

tag

protected FElem tag(byte[] tag,
                    FElem parent)
Description copied from class: Inspect
Creates a new element for the specified tag.

Specified by:
tag in class Inspect
Parameters:
tag - tag
parent - parent element
Returns:
element

type

protected void type(SeqType st,
                    FElem parent)
Creates a type element.

Parameters:
st - sequence type
parent - parent node