Class ClangDocumentation


  • public class ClangDocumentation
    extends java.lang.Object
    • Method Detail

      • nclang_Cursor_getParsedComment

        public static void nclang_Cursor_getParsedComment​(long C,
                                                          long __functionAddress,
                                                          long __result)
        
        public static void nclang_Cursor_getParsedComment​(long C,
                                                          long __result)
        
        Unsafe version of: Cursor_getParsedComment
      • clang_Cursor_getParsedComment

        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.
      • nclang_Comment_getKind

        public static int nclang_Comment_getKind​(long Comment,
                                                 long __functionAddress)
        
        public static int nclang_Comment_getKind​(long Comment)
        
        Unsafe version of: Comment_getKind
      • clang_Comment_getKind

        public static int clang_Comment_getKind​(CXComment Comment)
        Parameters:
        Comment - AST node of any kind
        Returns:
        the type of the AST node
      • nclang_Comment_getNumChildren

        public static int nclang_Comment_getNumChildren​(long Comment,
                                                        long __functionAddress)
        
        public static int nclang_Comment_getNumChildren​(long Comment)
        
        Unsafe version of: Comment_getNumChildren
      • clang_Comment_getNumChildren

        public static int clang_Comment_getNumChildren​(CXComment Comment)
        Parameters:
        Comment - AST node of any kind
        Returns:
        number of children of the AST node
      • nclang_Comment_getChild

        public static void nclang_Comment_getChild​(long Comment,
                                                   int ChildIdx,
                                                   long __functionAddress,
                                                   long __result)
        
        public static void nclang_Comment_getChild​(long Comment,
                                                   int ChildIdx,
                                                   long __result)
        
        Unsafe version of: Comment_getChild
      • clang_Comment_getChild

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

        public static int nclang_Comment_isWhitespace​(long Comment,
                                                      long __functionAddress)
        
        public static int nclang_Comment_isWhitespace​(long Comment)
        
        Unsafe version of: Comment_isWhitespace
      • clang_Comment_isWhitespace

        public static boolean clang_Comment_isWhitespace​(CXComment Comment)
        A Comment_Paragraph node is considered whitespace if it contains only Comment_Text nodes that are empty or whitespace.

        Other AST nodes (except CXComment_Paragraph and CXComment_Text) are never considered whitespace.

        Returns:
        non-zero if Comment is whitespace
      • nclang_InlineContentComment_hasTrailingNewline

        public static int nclang_InlineContentComment_hasTrailingNewline​(long Comment,
                                                                         long __functionAddress)
        
        public static int nclang_InlineContentComment_hasTrailingNewline​(long Comment)
        
      • clang_InlineContentComment_hasTrailingNewline

        public static boolean clang_InlineContentComment_hasTrailingNewline​(CXComment Comment)
        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.
      • nclang_TextComment_getText

        public static void nclang_TextComment_getText​(long Comment,
                                                      long __functionAddress,
                                                      long __result)
        
        public static void nclang_TextComment_getText​(long Comment,
                                                      long __result)
        
        Unsafe version of: TextComment_getText
      • clang_TextComment_getText

        public static CXString clang_TextComment_getText​(CXComment Comment,
                                                         CXString __result)
        Parameters:
        Comment - a Comment_Text AST node
        __result - text contained in the AST node
      • nclang_InlineCommandComment_getCommandName

        public static void nclang_InlineCommandComment_getCommandName​(long Comment,
                                                                      long __functionAddress,
                                                                      long __result)
        
        public static void nclang_InlineCommandComment_getCommandName​(long Comment,
                                                                      long __result)
        
      • clang_InlineCommandComment_getCommandName

        public static CXString clang_InlineCommandComment_getCommandName​(CXComment Comment,
                                                                         CXString __result)
        Parameters:
        Comment - a Comment_InlineCommand AST node
        __result - name of the inline command
      • nclang_InlineCommandComment_getRenderKind

        public static int nclang_InlineCommandComment_getRenderKind​(long Comment,
                                                                    long __functionAddress)
        
        public static int nclang_InlineCommandComment_getRenderKind​(long Comment)
        
      • clang_InlineCommandComment_getRenderKind

        public static int clang_InlineCommandComment_getRenderKind​(CXComment Comment)
        Parameters:
        Comment - a Comment_InlineCommand AST node
        Returns:
        the most appropriate rendering mode, chosen on command semantics in Doxygen
      • nclang_InlineCommandComment_getNumArgs

        public static int nclang_InlineCommandComment_getNumArgs​(long Comment,
                                                                 long __functionAddress)
        
        public static int nclang_InlineCommandComment_getNumArgs​(long Comment)
        
      • clang_InlineCommandComment_getNumArgs

        public static int clang_InlineCommandComment_getNumArgs​(CXComment Comment)
        Parameters:
        Comment - a Comment_InlineCommand AST node
        Returns:
        number of command arguments
      • nclang_InlineCommandComment_getArgText

        public static void nclang_InlineCommandComment_getArgText​(long Comment,
                                                                  int ArgIdx,
                                                                  long __functionAddress,
                                                                  long __result)
        
        public static void nclang_InlineCommandComment_getArgText​(long Comment,
                                                                  int ArgIdx,
                                                                  long __result)
        
      • clang_InlineCommandComment_getArgText

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

        public static void nclang_HTMLTagComment_getTagName​(long Comment,
                                                            long __functionAddress,
                                                            long __result)
        
        public static void nclang_HTMLTagComment_getTagName​(long Comment,
                                                            long __result)
        
        Unsafe version of: HTMLTagComment_getTagName
      • nclang_HTMLStartTagComment_isSelfClosing

        public static int nclang_HTMLStartTagComment_isSelfClosing​(long Comment,
                                                                   long __functionAddress)
        
        public static int nclang_HTMLStartTagComment_isSelfClosing​(long Comment)
        
      • clang_HTMLStartTagComment_isSelfClosing

        public static boolean clang_HTMLStartTagComment_isSelfClosing​(CXComment Comment)
        Parameters:
        Comment - a Comment_HTMLStartTag AST node
        Returns:
        non-zero if tag is self-closing (for example, <br /> )
      • nclang_HTMLStartTag_getNumAttrs

        public static int nclang_HTMLStartTag_getNumAttrs​(long Comment,
                                                          long __functionAddress)
        
        public static int nclang_HTMLStartTag_getNumAttrs​(long Comment)
        
        Unsafe version of: HTMLStartTag_getNumAttrs
      • clang_HTMLStartTag_getNumAttrs

        public static int clang_HTMLStartTag_getNumAttrs​(CXComment Comment)
        Parameters:
        Comment - a Comment_HTMLStartTag AST node
        Returns:
        number of attributes (name-value pairs) attached to the start tag
      • nclang_HTMLStartTag_getAttrName

        public static void nclang_HTMLStartTag_getAttrName​(long Comment,
                                                           int AttrIdx,
                                                           long __functionAddress,
                                                           long __result)
        
        public static void nclang_HTMLStartTag_getAttrName​(long Comment,
                                                           int AttrIdx,
                                                           long __result)
        
        Unsafe version of: HTMLStartTag_getAttrName
      • clang_HTMLStartTag_getAttrName

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

        public static void nclang_HTMLStartTag_getAttrValue​(long Comment,
                                                            int AttrIdx,
                                                            long __functionAddress,
                                                            long __result)
        
        public static void nclang_HTMLStartTag_getAttrValue​(long Comment,
                                                            int AttrIdx,
                                                            long __result)
        
        Unsafe version of: HTMLStartTag_getAttrValue
      • clang_HTMLStartTag_getAttrValue

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

        public static void nclang_BlockCommandComment_getCommandName​(long Comment,
                                                                     long __functionAddress,
                                                                     long __result)
        
        public static void nclang_BlockCommandComment_getCommandName​(long Comment,
                                                                     long __result)
        
      • clang_BlockCommandComment_getCommandName

        public static CXString clang_BlockCommandComment_getCommandName​(CXComment Comment,
                                                                        CXString __result)
        Parameters:
        Comment - a Comment_BlockCommand AST node
        __result - name of the block command
      • nclang_BlockCommandComment_getNumArgs

        public static int nclang_BlockCommandComment_getNumArgs​(long Comment,
                                                                long __functionAddress)
        
        public static int nclang_BlockCommandComment_getNumArgs​(long Comment)
        
      • clang_BlockCommandComment_getNumArgs

        public static int clang_BlockCommandComment_getNumArgs​(CXComment Comment)
        Parameters:
        Comment - a Comment_BlockCommand AST node
        Returns:
        number of word-like arguments
      • nclang_BlockCommandComment_getArgText

        public static void nclang_BlockCommandComment_getArgText​(long Comment,
                                                                 int ArgIdx,
                                                                 long __functionAddress,
                                                                 long __result)
        
        public static void nclang_BlockCommandComment_getArgText​(long Comment,
                                                                 int ArgIdx,
                                                                 long __result)
        
      • clang_BlockCommandComment_getArgText

        public static CXString clang_BlockCommandComment_getArgText​(CXComment Comment,
                                                                    int ArgIdx,
                                                                    CXString __result)
        Parameters:
        Comment - a Comment_BlockCommand AST node
        ArgIdx - argument index (zero-based)
        __result - text of the specified word-like argument
      • nclang_BlockCommandComment_getParagraph

        public static void nclang_BlockCommandComment_getParagraph​(long Comment,
                                                                   long __functionAddress,
                                                                   long __result)
        
        public static void nclang_BlockCommandComment_getParagraph​(long Comment,
                                                                   long __result)
        
      • nclang_ParamCommandComment_getParamName

        public static void nclang_ParamCommandComment_getParamName​(long Comment,
                                                                   long __functionAddress,
                                                                   long __result)
        
        public static void nclang_ParamCommandComment_getParamName​(long Comment,
                                                                   long __result)
        
      • clang_ParamCommandComment_getParamName

        public static CXString clang_ParamCommandComment_getParamName​(CXComment Comment,
                                                                      CXString __result)
        Parameters:
        Comment - a Comment_ParamCommand AST node
        __result - parameter name
      • nclang_ParamCommandComment_isParamIndexValid

        public static int nclang_ParamCommandComment_isParamIndexValid​(long Comment,
                                                                       long __functionAddress)
        
        public static int nclang_ParamCommandComment_isParamIndexValid​(long Comment)
        
      • clang_ParamCommandComment_isParamIndexValid

        public static boolean clang_ParamCommandComment_isParamIndexValid​(CXComment Comment)
        Parameters:
        Comment - a Comment_ParamCommand AST node
        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
      • nclang_ParamCommandComment_getParamIndex

        public static int nclang_ParamCommandComment_getParamIndex​(long Comment,
                                                                   long __functionAddress)
        
        public static int nclang_ParamCommandComment_getParamIndex​(long Comment)
        
      • clang_ParamCommandComment_getParamIndex

        public static int clang_ParamCommandComment_getParamIndex​(CXComment Comment)
        Parameters:
        Comment - a Comment_ParamCommand AST node
        Returns:
        zero-based parameter index in function prototype
      • nclang_ParamCommandComment_isDirectionExplicit

        public static int nclang_ParamCommandComment_isDirectionExplicit​(long Comment,
                                                                         long __functionAddress)
        
        public static int nclang_ParamCommandComment_isDirectionExplicit​(long Comment)
        
      • clang_ParamCommandComment_isDirectionExplicit

        public static boolean clang_ParamCommandComment_isDirectionExplicit​(CXComment Comment)
        Parameters:
        Comment - a Comment_ParamCommand AST node
        Returns:
        non-zero if parameter passing direction was specified explicitly in the comment
      • nclang_ParamCommandComment_getDirection

        public static int nclang_ParamCommandComment_getDirection​(long Comment,
                                                                  long __functionAddress)
        
        public static int nclang_ParamCommandComment_getDirection​(long Comment)
        
      • clang_ParamCommandComment_getDirection

        public static int clang_ParamCommandComment_getDirection​(CXComment Comment)
        Parameters:
        Comment - a Comment_ParamCommand AST node
        Returns:
        parameter passing direction
      • nclang_TParamCommandComment_getParamName

        public static void nclang_TParamCommandComment_getParamName​(long Comment,
                                                                    long __functionAddress,
                                                                    long __result)
        
        public static void nclang_TParamCommandComment_getParamName​(long Comment,
                                                                    long __result)
        
      • clang_TParamCommandComment_getParamName

        public static CXString clang_TParamCommandComment_getParamName​(CXComment Comment,
                                                                       CXString __result)
        Parameters:
        Comment - a Comment_TParamCommand AST node
        __result - template parameter name
      • nclang_TParamCommandComment_isParamPositionValid

        public static int nclang_TParamCommandComment_isParamPositionValid​(long Comment,
                                                                           long __functionAddress)
        
        public static int nclang_TParamCommandComment_isParamPositionValid​(long Comment)
        
      • nclang_TParamCommandComment_getDepth

        public static int nclang_TParamCommandComment_getDepth​(long Comment,
                                                               long __functionAddress)
        
        public static int nclang_TParamCommandComment_getDepth​(long Comment)
        
      • clang_TParamCommandComment_getDepth

        public static int clang_TParamCommandComment_getDepth​(CXComment Comment)
        For example,
        
              template<typename C, template<typename T> class TT>
              void test(TT<int> aaa);

        for C and TT nesting depth is 0, for T nesting depth is 1.

        Parameters:
        Comment - a Comment_TParamCommand AST node
        Returns:
        zero-based nesting depth of this parameter in the template parameter list
      • nclang_TParamCommandComment_getIndex

        public static int nclang_TParamCommandComment_getIndex​(long Comment,
                                                               int Depth,
                                                               long __functionAddress)
        
        public static int nclang_TParamCommandComment_getIndex​(long Comment,
                                                               int Depth)
        
      • clang_TParamCommandComment_getIndex

        public static int clang_TParamCommandComment_getIndex​(CXComment Comment,
                                                              int Depth)
        For example,
        
              template<typename C, template<typename T> class TT>
              void test(TT<int> aaa);

        for C and TT nesting depth is 0, so we can ask for index at depth 0: at depth 0 C's index is 0, TT's index is 1.

        For T nesting depth is 1, so we can ask for index at depth 0 and 1: at depth 0 T's index is 1 (same as TT's), at depth 1 T's index is 0.

        Parameters:
        Comment - a Comment_TParamCommand AST node
        Returns:
        zero-based parameter index in the template parameter list at a given nesting depth
      • nclang_VerbatimBlockLineComment_getText

        public static void nclang_VerbatimBlockLineComment_getText​(long Comment,
                                                                   long __functionAddress,
                                                                   long __result)
        
        public static void nclang_VerbatimBlockLineComment_getText​(long Comment,
                                                                   long __result)
        
      • nclang_VerbatimLineComment_getText

        public static void nclang_VerbatimLineComment_getText​(long Comment,
                                                              long __functionAddress,
                                                              long __result)
        
        public static void nclang_VerbatimLineComment_getText​(long Comment,
                                                              long __result)
        
        Unsafe version of: VerbatimLineComment_getText
      • clang_VerbatimLineComment_getText

        public static CXString clang_VerbatimLineComment_getText​(CXComment Comment,
                                                                 CXString __result)
        Parameters:
        Comment - a Comment_VerbatimLine AST node
        __result - text contained in the AST node
      • nclang_HTMLTagComment_getAsString

        public static void nclang_HTMLTagComment_getAsString​(long Comment,
                                                             long __functionAddress,
                                                             long __result)
        
        public static void nclang_HTMLTagComment_getAsString​(long Comment,
                                                             long __result)
        
        Unsafe version of: HTMLTagComment_getAsString
      • nclang_FullComment_getAsHTML

        public static void nclang_FullComment_getAsHTML​(long Comment,
                                                        long __functionAddress,
                                                        long __result)
        
        public static void nclang_FullComment_getAsHTML​(long Comment,
                                                        long __result)
        
        Unsafe version of: FullComment_getAsHTML
      • clang_FullComment_getAsHTML

        public static CXString clang_FullComment_getAsHTML​(CXComment Comment,
                                                           CXString __result)
        Convert a given full parsed comment to an HTML fragment.

        Specific details of HTML layout are subject to change. Don't try to parse this HTML back into an AST, use other APIs instead.

        Currently the following CSS classes are used:

        • "para-brief" for \paragraph and equivalent commands;
        • "para-returns" for \returns paragraph and equivalent commands;
        • "word-returns" for the "Returns" word in \returns paragraph.

        Function argument documentation is rendered as a <dl> list with arguments sorted in function prototype order. CSS classes used:

        • "param-name-index-NUMBER" for parameter name ( <dt> );
        • "param-descr-index-NUMBER" for parameter description ( <dd> );
        • "param-name-index-invalid" and "param-descr-index-invalid" are used if parameter index is invalid.

        Template parameter documentation is rendered as a <dl> list with parameters sorted in template parameter list order. CSS classes used:

        • "tparam-name-index-NUMBER" for parameter name ( <dt> );
        • "tparam-descr-index-NUMBER" for parameter description ( <dd> );
        • "tparam-name-index-other" and "tparam-descr-index-other" are used for names inside template template parameters;
        • "tparam-name-index-invalid" and "tparam-descr-index-invalid" are used if parameter position is invalid.
        Parameters:
        Comment - a Comment_FullComment AST node
        __result - string containing an HTML fragment
      • nclang_FullComment_getAsXML

        public static void nclang_FullComment_getAsXML​(long Comment,
                                                       long __functionAddress,
                                                       long __result)
        
        public static void nclang_FullComment_getAsXML​(long Comment,
                                                       long __result)
        
        Unsafe version of: FullComment_getAsXML
      • clang_FullComment_getAsXML

        public static CXString clang_FullComment_getAsXML​(CXComment Comment,
                                                          CXString __result)
        Convert a given full parsed comment to an XML document.

        A Relax NG schema for the XML can be found in comment-xml-schema.rng file inside clang source tree.

        Parameters:
        Comment - a Comment_FullComment AST node
        __result - string containing an XML document