Top Inners Fields Constructors Methods
org.lwjgl.llvm

public Class ClangDocumentation

extends Object
Class Inheritance
Imports
java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
ClangDocumentation.Functions

Contains the function pointers loaded from ClangIndex.getLibrary().

Field Summary

Modifier and TypeField and Description
public static final int
CXComment_BlockCommand

Describes the type of the comment AST node ( CXComment).

public static final int
CXComment_FullComment

Describes the type of the comment AST node ( CXComment).

public static final int
CXComment_HTMLEndTag

Describes the type of the comment AST node ( CXComment).

public static final int
CXComment_HTMLStartTag

Describes the type of the comment AST node ( CXComment).

public static final int
CXComment_InlineCommand

Describes the type of the comment AST node ( CXComment).

public static final int
CXComment_Null

Describes the type of the comment AST node ( CXComment).

public static final int
CXComment_Paragraph

Describes the type of the comment AST node ( CXComment).

public static final int
CXComment_ParamCommand

Describes the type of the comment AST node ( CXComment).

public static final int
CXComment_Text

Describes the type of the comment AST node ( CXComment).

public static final int
CXComment_TParamCommand

Describes the type of the comment AST node ( CXComment).

public static final int
CXComment_VerbatimBlockCommand

Describes the type of the comment AST node ( CXComment).

public static final int
CXComment_VerbatimBlockLine

Describes the type of the comment AST node ( CXComment).

public static final int
CXComment_VerbatimLine

Describes the type of the comment AST node ( CXComment).

public static final int
CXCommentInlineCommandRenderKind_Anchor

The most appropriate rendering mode for an inline command, chosen on command semantics in Doxygen.

public static final int
CXCommentInlineCommandRenderKind_Bold

The most appropriate rendering mode for an inline command, chosen on command semantics in Doxygen.

public static final int
CXCommentInlineCommandRenderKind_Emphasized

The most appropriate rendering mode for an inline command, chosen on command semantics in Doxygen.

public static final int
CXCommentInlineCommandRenderKind_Monospaced

The most appropriate rendering mode for an inline command, chosen on command semantics in Doxygen.

public static final int
CXCommentInlineCommandRenderKind_Normal

The most appropriate rendering mode for an inline command, chosen on command semantics in Doxygen.

public static final int
CXCommentParamPassDirection_In

Describes parameter passing direction for \param or \arg command.

public static final int
CXCommentParamPassDirection_InOut

Describes parameter passing direction for \param or \arg command.

public static final int
CXCommentParamPassDirection_Out

Describes parameter passing direction for \param or \arg command.

Constructor Summary

AccessConstructor and Description
protected
ClangDocumentation()

Method Summary

Modifier and TypeMethod and Description
public static CXString
clang_BlockCommandComment_getArgText(CXComment
a Comment_BlockCommand AST node
Comment, int
argument index (zero-based)
ArgIdx, CXString
text of the specified word-like argument
__result)

public static CXString
clang_BlockCommandComment_getCommandName(CXComment
a Comment_BlockCommand AST node
Comment, CXString
name of the block command
__result)

public static int

Returns:

number of word-like arguments
clang_BlockCommandComment_getNumArgs(CXComment
a Comment_BlockCommand AST node
Comment)

public static CXComment
clang_BlockCommandComment_getParagraph(CXComment
a Comment_BlockCommand or Comment_VerbatimBlockCommand AST node
Comment, CXComment
paragraph argument of the block command
__result)

public static CXComment
clang_Comment_getChild(CXComment
AST node of any kind
Comment, int
child index (zero-based)
ChildIdx, CXComment
the specified child of the AST node
__result)

public static int

Returns:

the type of the AST node
clang_Comment_getKind(CXComment
AST node of any kind
Comment)

public static int

Returns:

number of children of the AST node
clang_Comment_getNumChildren(CXComment
AST node of any kind
Comment)

public static boolean

Returns:

non-zero if Comment is whitespace
clang_Comment_isWhitespace(CXComment Comment)

A Comment_Paragraph node is considered whitespace if it contains only Comment_Text nodes that are empty or whitespace.

public static int

Returns:

error code indicating success or failure of the APISet creation
clang_createAPISet(long
the CXTranslationUnit to build the CXAPISet for
tu, PointerBuffer
a pointer to the output of this function. It is needs to be disposed of by calling disposeAPISet.
out_api)

Traverses the translation unit to create a CXAPISet.

public static CXComment
clang_Cursor_getParsedComment(CXCursor C, CXComment __result)

Given a cursor that represents a documentable entity (e.g., declaration), return the associated parsed comment as a Comment_FullComment AST node.

public static void
clang_disposeAPISet(long api)

Dispose of an APISet.

public static CXString
clang_FullComment_getAsHTML(CXComment
a Comment_FullComment AST node
Comment, CXString
string containing an HTML fragment
__result)

Convert a given full parsed comment to an HTML fragment.

public static CXString
clang_FullComment_getAsXML(CXComment
a Comment_FullComment AST node
Comment, CXString
string containing an XML document
__result)

Convert a given full parsed comment to an XML document.

public static CXString
clang_getSymbolGraphForCursor(CXCursor
the declaration for which to generate the single symbol symbol graph.
cursor, CXString
a string containing the serialized symbol graph representation for the symbol being queried or a null string if it can not be found in the APISet
__result)

Generate a single symbol symbol graph for the declaration at the given cursor.

public static CXString
clang_getSymbolGraphForUSR(ByteBuffer
a string containing the USR of the symbol to generate the symbol graph for
usr, long
the CXAPISet to look for the symbol in
api, CXString
a string containing the serialized symbol graph representation for the symbol being queried or a null string if it can not be found in the APISet
__result)

Generate a single symbol symbol graph for the given USR.

public static CXString
clang_getSymbolGraphForUSR(CharSequence
a string containing the USR of the symbol to generate the symbol graph for
usr, long
the CXAPISet to look for the symbol in
api, CXString
a string containing the serialized symbol graph representation for the symbol being queried or a null string if it can not be found in the APISet
__result)

Generate a single symbol symbol graph for the given USR.

public static CXString
clang_HTMLStartTag_getAttrName(CXComment
a Comment_HTMLStartTag AST node
Comment, int
attribute index (zero-based)
AttrIdx, CXString
name of the specified attribute
__result)

public static CXString
clang_HTMLStartTag_getAttrValue(CXComment
a Comment_HTMLStartTag AST node
Comment, int
attribute index (zero-based)
AttrIdx, CXString
value of the specified attribute
__result)

public static int

Returns:

number of attributes (name-value pairs) attached to the start tag
clang_HTMLStartTag_getNumAttrs(CXComment
a Comment_HTMLStartTag AST node
Comment)

public static boolean

Returns:

non-zero if tag is self-closing (for example, <br /> )
clang_HTMLStartTagComment_isSelfClosing(CXComment
a Comment_HTMLStartTag AST node
Comment)

public static CXString
clang_HTMLTagComment_getAsString(CXComment
a Comment_HTMLStartTag or Comment_HTMLEndTag AST node
Comment, CXString
string containing an HTML tag
__result)

Convert an HTML tag AST node to string.

public static CXString
clang_HTMLTagComment_getTagName(CXComment
a Comment_HTMLStartTag or Comment_HTMLEndTag AST node
Comment, CXString
HTML tag name
__result)

public static CXString
clang_InlineCommandComment_getArgText(CXComment
a Comment_InlineCommand AST node
Comment, int
argument index (zero-based)
ArgIdx, CXString
text of the specified argument
__result)

public static CXString
clang_InlineCommandComment_getCommandName(CXComment
a Comment_InlineCommand AST node
Comment, CXString
name of the inline command
__result)

public static int

Returns:

number of command arguments
clang_InlineCommandComment_getNumArgs(CXComment
a Comment_InlineCommand AST node
Comment)

public static int

Returns:

the most appropriate rendering mode, chosen on command semantics in Doxygen
clang_InlineCommandComment_getRenderKind(CXComment
a Comment_InlineCommand AST node
Comment)

public static boolean

Returns:

non-zero if Comment is inline content and has a newline immediately following it in the comment text. Newlines between paragraphs do not count.
clang_InlineContentComment_hasTrailingNewline(CXComment Comment)

public static int

Returns:

parameter passing direction
clang_ParamCommandComment_getDirection(CXComment
a Comment_ParamCommand AST node
Comment)

public static int

Returns:

zero-based parameter index in function prototype
clang_ParamCommandComment_getParamIndex(CXComment
a Comment_ParamCommand AST node
Comment)

public static CXString
clang_ParamCommandComment_getParamName(CXComment
a Comment_ParamCommand AST node
Comment, CXString
parameter name
__result)

public static boolean

Returns:

non-zero if parameter passing direction was specified explicitly in the comment
clang_ParamCommandComment_isDirectionExplicit(CXComment
a Comment_ParamCommand AST node
Comment)

public static boolean

Returns:

non-zero if the parameter that this AST node represents was found in the function prototype and ParamCommandComment_getParamIndex function will return a meaningful value
clang_ParamCommandComment_isParamIndexValid(CXComment
a Comment_ParamCommand AST node
Comment)

public static CXString
clang_TextComment_getText(CXComment
a Comment_Text AST node
Comment, CXString
text contained in the AST node
__result)

public static int

Returns:

zero-based nesting depth of this parameter in the template parameter list
clang_TParamCommandComment_getDepth(CXComment
a Comment_TParamCommand AST node
Comment)

For example, 


     template<typename C, template<typename T> class TT>
     void test(TT<int> aaa);
public static int

Returns:

zero-based parameter index in the template parameter list at a given nesting depth
clang_TParamCommandComment_getIndex(CXComment
a Comment_TParamCommand AST node
Comment, int Depth)

For example, 


     template<typename C, template<typename T> class TT>
     void test(TT<int> aaa);
public static CXString
clang_TParamCommandComment_getParamName(CXComment
a Comment_TParamCommand AST node
Comment, CXString
template parameter name
__result)

public static boolean

Returns:

non-zero if the parameter that this AST node represents was found in the template parameter list and TParamCommandComment_getDepth and TParamCommandComment_getIndex functions will return a meaningful value
clang_TParamCommandComment_isParamPositionValid(CXComment
a Comment_TParamCommand AST node
Comment)

public static CXString
clang_VerbatimBlockLineComment_getText(CXComment
a Comment_VerbatimBlockLine AST node
Comment, CXString
text contained in the AST node
__result)

public static CXString
clang_VerbatimLineComment_getText(CXComment
a Comment_VerbatimLine AST node
Comment, CXString
text contained in the AST node
__result)

public static native void
nclang_BlockCommandComment_getArgText(long Comment, int ArgIdx, long __functionAddress, long __result)

Unsafe version of: BlockCommandComment_getArgText

public static void
nclang_BlockCommandComment_getArgText(long Comment, int ArgIdx, long __result)

Unsafe version of: BlockCommandComment_getArgText

public static native void
nclang_BlockCommandComment_getCommandName(long Comment, long __functionAddress, long __result)

Unsafe version of: BlockCommandComment_getCommandName

public static void
nclang_BlockCommandComment_getCommandName(long Comment, long __result)

Unsafe version of: BlockCommandComment_getCommandName

public static native int
nclang_BlockCommandComment_getNumArgs(long Comment, long __functionAddress)

Unsafe version of: BlockCommandComment_getNumArgs

public static int
nclang_BlockCommandComment_getNumArgs(long Comment)

Unsafe version of: BlockCommandComment_getNumArgs

public static native void
nclang_BlockCommandComment_getParagraph(long Comment, long __functionAddress, long __result)

Unsafe version of: BlockCommandComment_getParagraph

public static void
nclang_BlockCommandComment_getParagraph(long Comment, long __result)

Unsafe version of: BlockCommandComment_getParagraph

public static native void
nclang_Comment_getChild(long Comment, int ChildIdx, long __functionAddress, long __result)

Unsafe version of: Comment_getChild

public static void
nclang_Comment_getChild(long Comment, int ChildIdx, long __result)

Unsafe version of: Comment_getChild

public static native int
nclang_Comment_getKind(long Comment, long __functionAddress)

Unsafe version of: Comment_getKind

public static int
nclang_Comment_getKind(long Comment)

Unsafe version of: Comment_getKind

public static native int
nclang_Comment_getNumChildren(long Comment, long __functionAddress)

Unsafe version of: Comment_getNumChildren

public static int
nclang_Comment_getNumChildren(long Comment)

Unsafe version of: Comment_getNumChildren

public static native int
nclang_Comment_isWhitespace(long Comment, long __functionAddress)

Unsafe version of: Comment_isWhitespace

public static int
nclang_Comment_isWhitespace(long Comment)

Unsafe version of: Comment_isWhitespace

public static int
nclang_createAPISet(long tu, long out_api)

Unsafe version of: createAPISet

public static native void
nclang_Cursor_getParsedComment(long C, long __functionAddress, long __result)

Unsafe version of: Cursor_getParsedComment

public static void
nclang_Cursor_getParsedComment(long C, long __result)

Unsafe version of: Cursor_getParsedComment

public static native void
nclang_FullComment_getAsHTML(long Comment, long __functionAddress, long __result)

Unsafe version of: FullComment_getAsHTML

public static void
nclang_FullComment_getAsHTML(long Comment, long __result)

Unsafe version of: FullComment_getAsHTML

public static native void
nclang_FullComment_getAsXML(long Comment, long __functionAddress, long __result)

Unsafe version of: FullComment_getAsXML

public static void
nclang_FullComment_getAsXML(long Comment, long __result)

Unsafe version of: FullComment_getAsXML

public static native void
nclang_getSymbolGraphForCursor(long cursor, long __functionAddress, long __result)

Unsafe version of: getSymbolGraphForCursor

public static void
nclang_getSymbolGraphForCursor(long cursor, long __result)

Unsafe version of: getSymbolGraphForCursor

public static native void
nclang_getSymbolGraphForUSR(long usr, long api, long __functionAddress, long __result)

Unsafe version of: getSymbolGraphForUSR

public static void
nclang_getSymbolGraphForUSR(long usr, long api, long __result)

Unsafe version of: getSymbolGraphForUSR

public static native void
nclang_HTMLStartTag_getAttrName(long Comment, int AttrIdx, long __functionAddress, long __result)

Unsafe version of: HTMLStartTag_getAttrName

public static void
nclang_HTMLStartTag_getAttrName(long Comment, int AttrIdx, long __result)

Unsafe version of: HTMLStartTag_getAttrName

public static native void
nclang_HTMLStartTag_getAttrValue(long Comment, int AttrIdx, long __functionAddress, long __result)

Unsafe version of: HTMLStartTag_getAttrValue

public static void
nclang_HTMLStartTag_getAttrValue(long Comment, int AttrIdx, long __result)

Unsafe version of: HTMLStartTag_getAttrValue

public static native int
nclang_HTMLStartTag_getNumAttrs(long Comment, long __functionAddress)

Unsafe version of: HTMLStartTag_getNumAttrs

public static int
nclang_HTMLStartTag_getNumAttrs(long Comment)

Unsafe version of: HTMLStartTag_getNumAttrs

public static native int
nclang_HTMLStartTagComment_isSelfClosing(long Comment, long __functionAddress)

Unsafe version of: HTMLStartTagComment_isSelfClosing

public static int
nclang_HTMLStartTagComment_isSelfClosing(long Comment)

Unsafe version of: HTMLStartTagComment_isSelfClosing

public static native void
nclang_HTMLTagComment_getAsString(long Comment, long __functionAddress, long __result)

Unsafe version of: HTMLTagComment_getAsString

public static void
nclang_HTMLTagComment_getAsString(long Comment, long __result)

Unsafe version of: HTMLTagComment_getAsString

public static native void
nclang_HTMLTagComment_getTagName(long Comment, long __functionAddress, long __result)

Unsafe version of: HTMLTagComment_getTagName

public static void
nclang_HTMLTagComment_getTagName(long Comment, long __result)

Unsafe version of: HTMLTagComment_getTagName

public static native void
nclang_InlineCommandComment_getArgText(long Comment, int ArgIdx, long __functionAddress, long __result)

Unsafe version of: InlineCommandComment_getArgText

public static void
nclang_InlineCommandComment_getArgText(long Comment, int ArgIdx, long __result)

Unsafe version of: InlineCommandComment_getArgText

public static native void
nclang_InlineCommandComment_getCommandName(long Comment, long __functionAddress, long __result)

Unsafe version of: InlineCommandComment_getCommandName

public static void
nclang_InlineCommandComment_getCommandName(long Comment, long __result)

Unsafe version of: InlineCommandComment_getCommandName

public static native int
nclang_InlineCommandComment_getNumArgs(long Comment, long __functionAddress)

Unsafe version of: InlineCommandComment_getNumArgs

public static int
nclang_InlineCommandComment_getNumArgs(long Comment)

Unsafe version of: InlineCommandComment_getNumArgs

public static native int
nclang_InlineCommandComment_getRenderKind(long Comment, long __functionAddress)

Unsafe version of: InlineCommandComment_getRenderKind

public static int
nclang_InlineCommandComment_getRenderKind(long Comment)

Unsafe version of: InlineCommandComment_getRenderKind

public static native int
nclang_InlineContentComment_hasTrailingNewline(long Comment, long __functionAddress)

Unsafe version of: InlineContentComment_hasTrailingNewline

public static int
nclang_InlineContentComment_hasTrailingNewline(long Comment)

Unsafe version of: InlineContentComment_hasTrailingNewline

public static native int
nclang_ParamCommandComment_getDirection(long Comment, long __functionAddress)

Unsafe version of: ParamCommandComment_getDirection

public static int
nclang_ParamCommandComment_getDirection(long Comment)

Unsafe version of: ParamCommandComment_getDirection

public static native int
nclang_ParamCommandComment_getParamIndex(long Comment, long __functionAddress)

Unsafe version of: ParamCommandComment_getParamIndex

public static int
nclang_ParamCommandComment_getParamIndex(long Comment)

Unsafe version of: ParamCommandComment_getParamIndex

public static native void
nclang_ParamCommandComment_getParamName(long Comment, long __functionAddress, long __result)

Unsafe version of: ParamCommandComment_getParamName

public static void
nclang_ParamCommandComment_getParamName(long Comment, long __result)

Unsafe version of: ParamCommandComment_getParamName

public static native int
nclang_ParamCommandComment_isDirectionExplicit(long Comment, long __functionAddress)

Unsafe version of: ParamCommandComment_isDirectionExplicit

public static int
nclang_ParamCommandComment_isDirectionExplicit(long Comment)

Unsafe version of: ParamCommandComment_isDirectionExplicit

public static native int
nclang_ParamCommandComment_isParamIndexValid(long Comment, long __functionAddress)

Unsafe version of: ParamCommandComment_isParamIndexValid

public static int
nclang_ParamCommandComment_isParamIndexValid(long Comment)

Unsafe version of: ParamCommandComment_isParamIndexValid

public static native void
nclang_TextComment_getText(long Comment, long __functionAddress, long __result)

Unsafe version of: TextComment_getText

public static void
nclang_TextComment_getText(long Comment, long __result)

Unsafe version of: TextComment_getText

public static native int
nclang_TParamCommandComment_getDepth(long Comment, long __functionAddress)

Unsafe version of: TParamCommandComment_getDepth

public static int
nclang_TParamCommandComment_getDepth(long Comment)

Unsafe version of: TParamCommandComment_getDepth

public static native int
nclang_TParamCommandComment_getIndex(long Comment, int Depth, long __functionAddress)

Unsafe version of: TParamCommandComment_getIndex

public static int
nclang_TParamCommandComment_getIndex(long Comment, int Depth)

Unsafe version of: TParamCommandComment_getIndex

public static native void
nclang_TParamCommandComment_getParamName(long Comment, long __functionAddress, long __result)

Unsafe version of: TParamCommandComment_getParamName

public static void
nclang_TParamCommandComment_getParamName(long Comment, long __result)

Unsafe version of: TParamCommandComment_getParamName

public static native int
nclang_TParamCommandComment_isParamPositionValid(long Comment, long __functionAddress)

Unsafe version of: TParamCommandComment_isParamPositionValid

public static int
nclang_TParamCommandComment_isParamPositionValid(long Comment)

Unsafe version of: TParamCommandComment_isParamPositionValid

public static native void
nclang_VerbatimBlockLineComment_getText(long Comment, long __functionAddress, long __result)

Unsafe version of: VerbatimBlockLineComment_getText

public static void
nclang_VerbatimBlockLineComment_getText(long Comment, long __result)

Unsafe version of: VerbatimBlockLineComment_getText

public static native void
nclang_VerbatimLineComment_getText(long Comment, long __functionAddress, long __result)

Unsafe version of: VerbatimLineComment_getText

public static void
nclang_VerbatimLineComment_getText(long Comment, long __result)

Unsafe version of: VerbatimLineComment_getText

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait