0001 // this file is generated by `create_swift_from_generated_interface.py` 0002 #if SWIFT_PACKAGE 0003 import Clang_C 0004 #endif 0005 private let library= toolchainLoader.load("libclang.dylib") 0006 // swiftlint:disable file_length 0007 // swiftlint:disable force_unwrapping 0008 // swiftlint:disable function_parameter_count 0009 // swiftlint:disable missing_docs 0010 // swiftlint:disable trailing_newline 0011 // swiftlint:disable variable_name 0012 // swiftlint:disable valid_docs 0013 // import Darwin 0014 // import Foundation 0015 // import SWXMLHash 0016 // import SourceKittenFramework 0017 0018 /*==-- clang-c/Documentation.h - Utilities for comment processing -*- C -*-===*\ 0019 |* *| 0020 |* The LLVM Compiler Infrastructure *| 0021 |* *| 0022 |* This file is distributed under the University of Illinois Open Source *| 0023 |* License. See LICENSE.TXT for details. *| 0024 |* *| 0025 |*===----------------------------------------------------------------------===*| 0026 |* *| 0027 |* This header provides a supplementary interface for inspecting *| 0028 |* documentation comments. *| 0029 |* *| 0030 \*===----------------------------------------------------------------------===*/ 0031 0032 /** 0033 * \defgroup CINDEX_COMMENT Comment introspection 0034 * 0035 * The routines in this group provide access to information in documentation 0036 * comments. These facilities are distinct from the core and may be subject to 0037 * their own schedule of stability and deprecation. 0038 * 0039 * @{ 0040 */ 0041 0042 /** 0043 * \brief A parsed comment. 0044 */ 0045 /* 0046 public struct CXComment { 0047 // public var ASTNode: UnsafePointer<Void> 0048 // public var TranslationUnit: CXTranslationUnit 0049 public init() 0050 public init(ASTNode: UnsafePointer<Void>, TranslationUnit: CXTranslationUnit) 0051 } 0052 */ 0053 0054 0055 0056 /** 0057 * \brief Given a cursor that represents a documentable entity (e.g., 0058 * declaration), return the associated parsed comment as a 0059 * \c CXComment_FullComment AST node. 0060 */ 0061 public func clang_Cursor_getParsedComment
created_Documentation.swift:64 private let _clang_Cursor_getParsedComment: @convention(c) (C: CXCursor) -> CXComment = library.loadSymbol("clang_Cursor_getParsedComment")created_Documentation.swift:252 private let _clang_Comment_getKind: @convention(c) (Comment: CXComment) -> CXCommentKind = library.loadSymbol("clang_Comment_getKind")created_Documentation.swift:263 private let _clang_Comment_getNumChildren: @convention(c) (Comment: CXComment) -> UInt32 = library.loadSymbol("clang_Comment_getNumChildren")created_Documentation.swift:277 private let _clang_Comment_getChild: @convention(c) (Comment: CXComment, ChildIdx: UInt32) -> CXComment = library.loadSymbol("clang_Comment_getChild")created_Documentation.swift:292 private let _clang_Comment_isWhitespace: @convention(c) (Comment: CXComment) -> UInt32 = library.loadSymbol("clang_Comment_isWhitespace")created_Documentation.swift:304 private let _clang_InlineContentComment_hasTrailingNewline: @convention(c) (Comment: CXComment) -> UInt32 = library.loadSymbol("clang_InlineContentComment_hasTrailingNewline")created_Documentation.swift:315 private let _clang_TextComment_getText: @convention(c) (Comment: CXComment) -> CXString = library.loadSymbol("clang_TextComment_getText")created_Documentation.swift:327 private let _clang_InlineCommandComment_getCommandName: @convention(c) (Comment: CXComment) -> CXString = library.loadSymbol("clang_InlineCommandComment_getCommandName")created_Documentation.swift:339 private let _clang_InlineCommandComment_getRenderKind: @convention(c) (Comment: CXComment) -> CXCommentInlineCommandRenderKind = library.loadSymbol("clang_InlineCommandComment_getRenderKind")created_Documentation.swift:351 private let _clang_InlineCommandComment_getNumArgs: @convention(c) (Comment: CXComment) -> UInt32 = library.loadSymbol("clang_InlineCommandComment_getNumArgs")created_Documentation.swift:365 private let _clang_InlineCommandComment_getArgText: @convention(c) (Comment: CXComment, ArgIdx: UInt32) -> CXString = library.loadSymbol("clang_InlineCommandComment_getArgText")created_Documentation.swift:377 private let _clang_HTMLTagComment_getTagName: @convention(c) (Comment: CXComment) -> CXString = library.loadSymbol("clang_HTMLTagComment_getTagName")created_Documentation.swift:389 private let _clang_HTMLStartTagComment_isSelfClosing: @convention(c) (Comment: CXComment) -> UInt32 = library.loadSymbol("clang_HTMLStartTagComment_isSelfClosing")created_Documentation.swift:400 private let _clang_HTMLStartTag_getNumAttrs: @convention(c) (Comment: CXComment) -> UInt32 = library.loadSymbol("clang_HTMLStartTag_getNumAttrs")created_Documentation.swift:414 private let _clang_HTMLStartTag_getAttrName: @convention(c) (Comment: CXComment, AttrIdx: UInt32) -> CXString = library.loadSymbol("clang_HTMLStartTag_getAttrName")created_Documentation.swift:428 private let _clang_HTMLStartTag_getAttrValue: @convention(c) (Comment: CXComment, AttrIdx: UInt32) -> CXString = library.loadSymbol("clang_HTMLStartTag_getAttrValue")created_Documentation.swift:440 private let _clang_BlockCommandComment_getCommandName: @convention(c) (Comment: CXComment) -> CXString = library.loadSymbol("clang_BlockCommandComment_getCommandName")created_Documentation.swift:452 private let _clang_BlockCommandComment_getNumArgs: @convention(c) (Comment: CXComment) -> UInt32 = library.loadSymbol("clang_BlockCommandComment_getNumArgs")created_Documentation.swift:466 private let _clang_BlockCommandComment_getArgText: @convention(c) (Comment: CXComment, ArgIdx: UInt32) -> CXString = library.loadSymbol("clang_BlockCommandComment_getArgText")created_Documentation.swift:479 private let _clang_BlockCommandComment_getParagraph: @convention(c) (Comment: CXComment) -> CXComment = library.loadSymbol("clang_BlockCommandComment_getParagraph")created_Documentation.swift:491 private let _clang_ParamCommandComment_getParamName: @convention(c) (Comment: CXComment) -> CXString = library.loadSymbol("clang_ParamCommandComment_getParamName")created_Documentation.swift:505 private let _clang_ParamCommandComment_isParamIndexValid: @convention(c) (Comment: CXComment) -> UInt32 = library.loadSymbol("clang_ParamCommandComment_isParamIndexValid")created_Documentation.swift:517 private let _clang_ParamCommandComment_getParamIndex: @convention(c) (Comment: CXComment) -> UInt32 = library.loadSymbol("clang_ParamCommandComment_getParamIndex")created_Documentation.swift:530 private let _clang_ParamCommandComment_isDirectionExplicit: @convention(c) (Comment: CXComment) -> UInt32 = library.loadSymbol("clang_ParamCommandComment_isDirectionExplicit")created_Documentation.swift:542 private let _clang_ParamCommandComment_getDirection: @convention(c) (Comment: CXComment) -> CXCommentParamPassDirection = library.loadSymbol("clang_ParamCommandComment_getDirection")created_Documentation.swift:554 private let _clang_TParamCommandComment_getParamName: @convention(c) (Comment: CXComment) -> CXString = library.loadSymbol("clang_TParamCommandComment_getParamName")created_Documentation.swift:570 private let _clang_TParamCommandComment_isParamPositionValid: @convention(c) (Comment: CXComment) -> UInt32 = library.loadSymbol("clang_TParamCommandComment_isParamPositionValid")created_Documentation.swift:590 private let _clang_TParamCommandComment_getDepth: @convention(c) (Comment: CXComment) -> UInt32 = library.loadSymbol("clang_TParamCommandComment_getDepth")created_Documentation.swift:615 private let _clang_TParamCommandComment_getIndex: @convention(c) (Comment: CXComment, Depth: UInt32) -> UInt32 = library.loadSymbol("clang_TParamCommandComment_getIndex")created_Documentation.swift:627 private let _clang_VerbatimBlockLineComment_getText: @convention(c) (Comment: CXComment) -> CXString = library.loadSymbol("clang_VerbatimBlockLineComment_getText")created_Documentation.swift:638 private let _clang_VerbatimLineComment_getText: @convention(c) (Comment: CXComment) -> CXString = library.loadSymbol("clang_VerbatimLineComment_getText")created_Documentation.swift:652 private let _clang_HTMLTagComment_getAsString: @convention(c) (Comment: CXComment) -> CXString = library.loadSymbol("clang_HTMLTagComment_getAsString")created_Documentation.swift:689 private let _clang_FullComment_getAsHTML: @convention(c) (Comment: CXComment) -> CXString = library.loadSymbol("clang_FullComment_getAsHTML")created_Documentation.swift:705 private let _clang_FullComment_getAsXML: @convention(c) (Comment: CXComment) -> CXString = library.loadSymbol("clang_FullComment_getAsXML")(C: CXCursor) -> CXComment { 0062 return _clang_Cursor_getParsedComment(C: C) 0063 } 0064 private let _clang_Cursor_getParsedComment
Clang+SourceKitten.swift:126 : @convention(c) (C: CXCursor) -> CXComment = library.loadSymbol("clang_Cursor_getParsedComment") 0065 0066 0067 /** 0068 * \brief Describes the type of the comment AST node (\c CXComment). A comment 0069 * node can be considered block content (e. g., paragraph), inline content 0070 * (plain text) or neither (the root AST node). 0071 */ 0072 /* 0073 public struct CXCommentKind : RawRepresentable, Equatable { 0074 public init(_ rawValue: UInt32) 0075 public init(rawValue: UInt32) 0076 // public var rawValue: UInt32 0077 } 0078 */ 0079 0080 /** 0081 * \brief Null comment. No AST node is constructed at the requested location 0082 * because there is no text or a syntax error. 0083 */ 0084 // public var CXComment_Null: CXCommentKind { get } 0085 0086 /** 0087 * \brief Plain text. Inline content. 0088 */ 0089 // public var CXComment_Text: CXCommentKind { get } 0090 0091 /** 0092 * \brief A command with word-like arguments that is considered inline content. 0093 * 0094 * For example: \\c command. 0095 */ 0096 // public var CXComment_InlineCommand: CXCommentKind { get } 0097 0098 /** 0099 * \brief HTML start tag with attributes (name-value pairs). Considered 0100 * inline content. 0101 * 0102 * For example: 0103 * \verbatim 0104 * <br> <br /> <a href="http://example.org/"> 0105 * \endverbatim 0106 */ 0107 // public var CXComment_HTMLStartTag: CXCommentKind { get } 0108 0109 /** 0110 * \brief HTML end tag. Considered inline content. 0111 * 0112 * For example: 0113 * \verbatim 0114 * </a> 0115 * \endverbatim 0116 */ 0117 // public var CXComment_HTMLEndTag: CXCommentKind { get } 0118 0119 /** 0120 * \brief A paragraph, contains inline comment. The paragraph itself is 0121 * block content. 0122 */ 0123 // public var CXComment_Paragraph: CXCommentKind { get } 0124 0125 /** 0126 * \brief A command that has zero or more word-like arguments (number of 0127 * word-like arguments depends on command name) and a paragraph as an 0128 * argument. Block command is block content. 0129 * 0130 * Paragraph argument is also a child of the block command. 0131 * 0132 * For example: \\brief has 0 word-like arguments and a paragraph argument. 0133 * 0134 * AST nodes of special kinds that parser knows about (e. g., \\param 0135 * command) have their own node kinds. 0136 */ 0137 // public var CXComment_BlockCommand: CXCommentKind { get } 0138 0139 /** 0140 * \brief A \\param or \\arg command that describes the function parameter 0141 * (name, passing direction, description). 0142 * 0143 * For example: \\param [in] ParamName description. 0144 */ 0145 // public var CXComment_ParamCommand: CXCommentKind { get } 0146 0147 /** 0148 * \brief A \\tparam command that describes a template parameter (name and 0149 * description). 0150 * 0151 * For example: \\tparam T description. 0152 */ 0153 // public var CXComment_TParamCommand: CXCommentKind { get } 0154 0155 /** 0156 * \brief A verbatim block command (e. g., preformatted code). Verbatim 0157 * block has an opening and a closing command and contains multiple lines of 0158 * text (\c CXComment_VerbatimBlockLine child nodes). 0159 * 0160 * For example: 0161 * \\verbatim 0162 * aaa 0163 * \\endverbatim 0164 */ 0165 // public var CXComment_VerbatimBlockCommand: CXCommentKind { get } 0166 0167 /** 0168 * \brief A line of text that is contained within a 0169 * CXComment_VerbatimBlockCommand node. 0170 */ 0171 // public var CXComment_VerbatimBlockLine: CXCommentKind { get } 0172 0173 /** 0174 * \brief A verbatim line command. Verbatim line has an opening command, 0175 * a single line of text (up to the newline after the opening command) and 0176 * has no closing command. 0177 */ 0178 // public var CXComment_VerbatimLine: CXCommentKind { get } 0179 0180 /** 0181 * \brief A full comment attached to a declaration, contains block content. 0182 */ 0183 // public var CXComment_FullComment: CXCommentKind { get } 0184 0185 /** 0186 * \brief The most appropriate rendering mode for an inline command, chosen on 0187 * command semantics in Doxygen. 0188 */ 0189 /* 0190 public struct CXCommentInlineCommandRenderKind : RawRepresentable, Equatable { 0191 public init(_ rawValue: UInt32) 0192 public init(rawValue: UInt32) 0193 // public var rawValue: UInt32 0194 } 0195 */ 0196 0197 /** 0198 * \brief Command argument should be rendered in a normal font. 0199 */ 0200 // public var CXCommentInlineCommandRenderKind_Normal: CXCommentInlineCommandRenderKind { get } 0201 0202 /** 0203 * \brief Command argument should be rendered in a bold font. 0204 */ 0205 // public var CXCommentInlineCommandRenderKind_Bold: CXCommentInlineCommandRenderKind { get } 0206 0207 /** 0208 * \brief Command argument should be rendered in a monospaced font. 0209 */ 0210 // public var CXCommentInlineCommandRenderKind_Monospaced: CXCommentInlineCommandRenderKind { get } 0211 0212 /** 0213 * \brief Command argument should be rendered emphasized (typically italic 0214 * font). 0215 */ 0216 // public var CXCommentInlineCommandRenderKind_Emphasized: CXCommentInlineCommandRenderKind { get } 0217 0218 /** 0219 * \brief Describes parameter passing direction for \\param or \\arg command. 0220 */ 0221 /* 0222 public struct CXCommentParamPassDirection : RawRepresentable, Equatable { 0223 public init(_ rawValue: UInt32) 0224 public init(rawValue: UInt32) 0225 // public var rawValue: UInt32 0226 } 0227 */ 0228 0229 /** 0230 * \brief The parameter is an input parameter. 0231 */ 0232 // public var CXCommentParamPassDirection_In: CXCommentParamPassDirection { get } 0233 0234 /** 0235 * \brief The parameter is an output parameter. 0236 */ 0237 // public var CXCommentParamPassDirection_Out: CXCommentParamPassDirection { get } 0238 0239 /** 0240 * \brief The parameter is an input and output parameter. 0241 */ 0242 // public var CXCommentParamPassDirection_InOut: CXCommentParamPassDirection { get } 0243 0244 /** 0245 * \param Comment AST node of any kind. 0246 * 0247 * \returns the type of the AST node. 0248 */ 0249 public func clang_Comment_getKind
created_Documentation.swift:62 (Comment: CXComment) -> CXCommentKind { 0250 return _clang_Comment_getKind(Comment: Comment) 0251 } 0252 private let _clang_Comment_getKind
Clang+SourceKitten.swift:159 guard clang_Comment_getKind(self) == CXComment_ParamCommand else { return nil }Clang+SourceKitten.swift:206 : @convention(c) (Comment: CXComment) -> CXCommentKind = library.loadSymbol("clang_Comment_getKind") 0253 0254 0255 /** 0256 * \param Comment AST node of any kind. 0257 * 0258 * \returns number of children of the AST node. 0259 */ 0260 public func clang_Comment_getNumChildren
created_Documentation.swift:250 (Comment: CXComment) -> UInt32 { 0261 return _clang_Comment_getNumChildren(Comment: Comment) 0262 } 0263 private let _clang_Comment_getNumChildren
Clang+SourceKitten.swift:173 for i in 0..<clang_Comment_getNumChildren(self) {Clang+SourceKitten.swift:186 for i in 0..<clang_Comment_getNumChildren(self) {Clang+SourceKitten.swift:214 : @convention(c) (Comment: CXComment) -> UInt32 = library.loadSymbol("clang_Comment_getNumChildren") 0264 0265 0266 0267 /** 0268 * \param Comment AST node of any kind. 0269 * 0270 * \param ChildIdx child index (zero-based). 0271 * 0272 * \returns the specified child of the AST node. 0273 */ 0274 public func clang_Comment_getChild
created_Documentation.swift:261 (Comment: CXComment, _ ChildIdx: UInt32) -> CXComment { 0275 return _clang_Comment_getChild(Comment: Comment, ChildIdx: ChildIdx) 0276 } 0277 private let _clang_Comment_getChild
Clang+SourceKitten.swift:174 Clang+SourceKitten.swift:187 Clang+SourceKitten.swift:218 : @convention(c) (Comment: CXComment, ChildIdx: UInt32) -> CXComment = library.loadSymbol("clang_Comment_getChild") 0278 0279 0280 /** 0281 * \brief A \c CXComment_Paragraph node is considered whitespace if it contains 0282 * only \c CXComment_Text nodes that are empty or whitespace. 0283 * 0284 * Other AST nodes (except \c CXComment_Paragraph and \c CXComment_Text) are 0285 * never considered whitespace. 0286 * 0287 * \returns non-zero if \c Comment is whitespace. 0288 */ 0289 public func clang_Comment_isWhitespace(Comment: CXComment) -> UInt32 { 0290 return _clang_Comment_isWhitespace(Comment: Comment) 0291 } 0292 private let _clang_Comment_isWhitespace
created_Documentation.swift:275 : @convention(c) (Comment: CXComment) -> UInt32 = library.loadSymbol("clang_Comment_isWhitespace") 0293 0294 0295 0296 /** 0297 * \returns non-zero if \c Comment is inline content and has a newline 0298 * immediately following it in the comment text. Newlines between paragraphs 0299 * do not count. 0300 */ 0301 public func clang_InlineContentComment_hasTrailingNewline(Comment: CXComment) -> UInt32 { 0302 return _clang_InlineContentComment_hasTrailingNewline(Comment: Comment) 0303 } 0304 private let _clang_InlineContentComment_hasTrailingNewline
created_Documentation.swift:290 : @convention(c) (Comment: CXComment) -> UInt32 = library.loadSymbol("clang_InlineContentComment_hasTrailingNewline") 0305 0306 0307 /** 0308 * \param Comment a \c CXComment_Text AST node. 0309 * 0310 * \returns text contained in the AST node. 0311 */ 0312 public func clang_TextComment_getText
created_Documentation.swift:302 (Comment: CXComment) -> CXString { 0313 return _clang_TextComment_getText(Comment: Comment) 0314 } 0315 private let _clang_TextComment_getText
Clang+SourceKitten.swift:188 if let text = clang_TextComment_getText(child).str() {: @convention(c) (Comment: CXComment) -> CXString = library.loadSymbol("clang_TextComment_getText") 0316 0317 0318 0319 /** 0320 * \param Comment a \c CXComment_InlineCommand AST node. 0321 * 0322 * \returns name of the inline command. 0323 */ 0324 public func clang_InlineCommandComment_getCommandName
created_Documentation.swift:313 (Comment: CXComment) -> CXString { 0325 return _clang_InlineCommandComment_getCommandName(Comment: Comment) 0326 } 0327 private let _clang_InlineCommandComment_getCommandName
Clang+SourceKitten.swift:196 : @convention(c) (Comment: CXComment) -> CXString = library.loadSymbol("clang_InlineCommandComment_getCommandName") 0328 0329 0330 /** 0331 * \param Comment a \c CXComment_InlineCommand AST node. 0332 * 0333 * \returns the most appropriate rendering mode, chosen on command 0334 * semantics in Doxygen. 0335 */ 0336 public func clang_InlineCommandComment_getRenderKind(Comment: CXComment) -> CXCommentInlineCommandRenderKind { 0337 return _clang_InlineCommandComment_getRenderKind(Comment: Comment) 0338 } 0339 private let _clang_InlineCommandComment_getRenderKind
created_Documentation.swift:325 : @convention(c) (Comment: CXComment) -> CXCommentInlineCommandRenderKind = library.loadSymbol("clang_InlineCommandComment_getRenderKind") 0340 0341 0342 0343 /** 0344 * \param Comment a \c CXComment_InlineCommand AST node. 0345 * 0346 * \returns number of command arguments. 0347 */ 0348 public func clang_InlineCommandComment_getNumArgs(Comment: CXComment) -> UInt32 { 0349 return _clang_InlineCommandComment_getNumArgs(Comment: Comment) 0350 } 0351 private let _clang_InlineCommandComment_getNumArgs
created_Documentation.swift:337 : @convention(c) (Comment: CXComment) -> UInt32 = library.loadSymbol("clang_InlineCommandComment_getNumArgs") 0352 0353 0354 0355 /** 0356 * \param Comment a \c CXComment_InlineCommand AST node. 0357 * 0358 * \param ArgIdx argument index (zero-based). 0359 * 0360 * \returns text of the specified argument. 0361 */ 0362 public func clang_InlineCommandComment_getArgText(Comment: CXComment, _ ArgIdx: UInt32) -> CXString { 0363 return _clang_InlineCommandComment_getArgText(Comment: Comment, ArgIdx: ArgIdx) 0364 } 0365 private let _clang_InlineCommandComment_getArgText
created_Documentation.swift:349 : @convention(c) (Comment: CXComment, ArgIdx: UInt32) -> CXString = library.loadSymbol("clang_InlineCommandComment_getArgText") 0366 0367 0368 /** 0369 * \param Comment a \c CXComment_HTMLStartTag or \c CXComment_HTMLEndTag AST 0370 * node. 0371 * 0372 * \returns HTML tag name. 0373 */ 0374 public func clang_HTMLTagComment_getTagName(Comment: CXComment) -> CXString { 0375 return _clang_HTMLTagComment_getTagName(Comment: Comment) 0376 } 0377 private let _clang_HTMLTagComment_getTagName
created_Documentation.swift:363 : @convention(c) (Comment: CXComment) -> CXString = library.loadSymbol("clang_HTMLTagComment_getTagName") 0378 0379 0380 0381 /** 0382 * \param Comment a \c CXComment_HTMLStartTag AST node. 0383 * 0384 * \returns non-zero if tag is self-closing (for example, <br />). 0385 */ 0386 public func clang_HTMLStartTagComment_isSelfClosing(Comment: CXComment) -> UInt32 { 0387 return _clang_HTMLStartTagComment_isSelfClosing(Comment: Comment) 0388 } 0389 private let _clang_HTMLStartTagComment_isSelfClosing
created_Documentation.swift:375 : @convention(c) (Comment: CXComment) -> UInt32 = library.loadSymbol("clang_HTMLStartTagComment_isSelfClosing") 0390 0391 0392 /** 0393 * \param Comment a \c CXComment_HTMLStartTag AST node. 0394 * 0395 * \returns number of attributes (name-value pairs) attached to the start tag. 0396 */ 0397 public func clang_HTMLStartTag_getNumAttrs(Comment: CXComment) -> UInt32 { 0398 return _clang_HTMLStartTag_getNumAttrs(Comment: Comment) 0399 } 0400 private let _clang_HTMLStartTag_getNumAttrs
created_Documentation.swift:387 : @convention(c) (Comment: CXComment) -> UInt32 = library.loadSymbol("clang_HTMLStartTag_getNumAttrs") 0401 0402 0403 0404 /** 0405 * \param Comment a \c CXComment_HTMLStartTag AST node. 0406 * 0407 * \param AttrIdx attribute index (zero-based). 0408 * 0409 * \returns name of the specified attribute. 0410 */ 0411 public func clang_HTMLStartTag_getAttrName(Comment: CXComment, _ AttrIdx: UInt32) -> CXString { 0412 return _clang_HTMLStartTag_getAttrName(Comment: Comment, AttrIdx: AttrIdx) 0413 } 0414 private let _clang_HTMLStartTag_getAttrName
created_Documentation.swift:398 : @convention(c) (Comment: CXComment, AttrIdx: UInt32) -> CXString = library.loadSymbol("clang_HTMLStartTag_getAttrName") 0415 0416 0417 0418 /** 0419 * \param Comment a \c CXComment_HTMLStartTag AST node. 0420 * 0421 * \param AttrIdx attribute index (zero-based). 0422 * 0423 * \returns value of the specified attribute. 0424 */ 0425 public func clang_HTMLStartTag_getAttrValue(Comment: CXComment, _ AttrIdx: UInt32) -> CXString { 0426 return _clang_HTMLStartTag_getAttrValue(Comment: Comment, AttrIdx: AttrIdx) 0427 } 0428 private let _clang_HTMLStartTag_getAttrValue
created_Documentation.swift:412 : @convention(c) (Comment: CXComment, AttrIdx: UInt32) -> CXString = library.loadSymbol("clang_HTMLStartTag_getAttrValue") 0429 0430 0431 0432 /** 0433 * \param Comment a \c CXComment_BlockCommand AST node. 0434 * 0435 * \returns name of the block command. 0436 */ 0437 public func clang_BlockCommandComment_getCommandName
created_Documentation.swift:426 (Comment: CXComment) -> CXString { 0438 return _clang_BlockCommandComment_getCommandName(Comment: Comment) 0439 } 0440 private let _clang_BlockCommandComment_getCommandName
Clang+SourceKitten.swift:210 : @convention(c) (Comment: CXComment) -> CXString = library.loadSymbol("clang_BlockCommandComment_getCommandName") 0441 0442 0443 0444 /** 0445 * \param Comment a \c CXComment_BlockCommand AST node. 0446 * 0447 * \returns number of word-like arguments. 0448 */ 0449 public func clang_BlockCommandComment_getNumArgs(Comment: CXComment) -> UInt32 { 0450 return _clang_BlockCommandComment_getNumArgs(Comment: Comment) 0451 } 0452 private let _clang_BlockCommandComment_getNumArgs
created_Documentation.swift:438 : @convention(c) (Comment: CXComment) -> UInt32 = library.loadSymbol("clang_BlockCommandComment_getNumArgs") 0453 0454 0455 0456 /** 0457 * \param Comment a \c CXComment_BlockCommand AST node. 0458 * 0459 * \param ArgIdx argument index (zero-based). 0460 * 0461 * \returns text of the specified word-like argument. 0462 */ 0463 public func clang_BlockCommandComment_getArgText(Comment: CXComment, _ ArgIdx: UInt32) -> CXString { 0464 return _clang_BlockCommandComment_getArgText(Comment: Comment, ArgIdx: ArgIdx) 0465 } 0466 private let _clang_BlockCommandComment_getArgText
created_Documentation.swift:450 : @convention(c) (Comment: CXComment, ArgIdx: UInt32) -> CXString = library.loadSymbol("clang_BlockCommandComment_getArgText") 0467 0468 0469 0470 /** 0471 * \param Comment a \c CXComment_BlockCommand or 0472 * \c CXComment_VerbatimBlockCommand AST node. 0473 * 0474 * \returns paragraph argument of the block command. 0475 */ 0476 public func clang_BlockCommandComment_getParagraph
created_Documentation.swift:464 (Comment: CXComment) -> CXComment { 0477 return _clang_BlockCommandComment_getParagraph(Comment: Comment) 0478 } 0479 private let _clang_BlockCommandComment_getParagraph
Clang+SourceKitten.swift:164 : @convention(c) (Comment: CXComment) -> CXComment = library.loadSymbol("clang_BlockCommandComment_getParagraph") 0480 0481 0482 0483 /** 0484 * \param Comment a \c CXComment_ParamCommand AST node. 0485 * 0486 * \returns parameter name. 0487 */ 0488 public func clang_ParamCommandComment_getParamName
created_Documentation.swift:477 (Comment: CXComment) -> CXString { 0489 return _clang_ParamCommandComment_getParamName(Comment: Comment) 0490 } 0491 private let _clang_ParamCommandComment_getParamName
Clang+SourceKitten.swift:160 : @convention(c) (Comment: CXComment) -> CXString = library.loadSymbol("clang_ParamCommandComment_getParamName") 0492 0493 0494 0495 /** 0496 * \param Comment a \c CXComment_ParamCommand AST node. 0497 * 0498 * \returns non-zero if the parameter that this AST node represents was found 0499 * in the function prototype and \c clang_ParamCommandComment_getParamIndex 0500 * function will return a meaningful value. 0501 */ 0502 public func clang_ParamCommandComment_isParamIndexValid(Comment: CXComment) -> UInt32 { 0503 return _clang_ParamCommandComment_isParamIndexValid(Comment: Comment) 0504 } 0505 private let _clang_ParamCommandComment_isParamIndexValid
created_Documentation.swift:489 : @convention(c) (Comment: CXComment) -> UInt32 = library.loadSymbol("clang_ParamCommandComment_isParamIndexValid") 0506 0507 0508 0509 /** 0510 * \param Comment a \c CXComment_ParamCommand AST node. 0511 * 0512 * \returns zero-based parameter index in function prototype. 0513 */ 0514 public func clang_ParamCommandComment_getParamIndex(Comment: CXComment) -> UInt32 { 0515 return _clang_ParamCommandComment_getParamIndex(Comment: Comment) 0516 } 0517 private let _clang_ParamCommandComment_getParamIndex
created_Documentation.swift:503 : @convention(c) (Comment: CXComment) -> UInt32 = library.loadSymbol("clang_ParamCommandComment_getParamIndex") 0518 0519 0520 0521 /** 0522 * \param Comment a \c CXComment_ParamCommand AST node. 0523 * 0524 * \returns non-zero if parameter passing direction was specified explicitly in 0525 * the comment. 0526 */ 0527 public func clang_ParamCommandComment_isDirectionExplicit(Comment: CXComment) -> UInt32 { 0528 return _clang_ParamCommandComment_isDirectionExplicit(Comment: Comment) 0529 } 0530 private let _clang_ParamCommandComment_isDirectionExplicit
created_Documentation.swift:515 : @convention(c) (Comment: CXComment) -> UInt32 = library.loadSymbol("clang_ParamCommandComment_isDirectionExplicit") 0531 0532 0533 0534 /** 0535 * \param Comment a \c CXComment_ParamCommand AST node. 0536 * 0537 * \returns parameter passing direction. 0538 */ 0539 public func clang_ParamCommandComment_getDirection(Comment: CXComment) -> CXCommentParamPassDirection { 0540 return _clang_ParamCommandComment_getDirection(Comment: Comment) 0541 } 0542 private let _clang_ParamCommandComment_getDirection
created_Documentation.swift:528 : @convention(c) (Comment: CXComment) -> CXCommentParamPassDirection = library.loadSymbol("clang_ParamCommandComment_getDirection") 0543 0544 0545 0546 /** 0547 * \param Comment a \c CXComment_TParamCommand AST node. 0548 * 0549 * \returns template parameter name. 0550 */ 0551 public func clang_TParamCommandComment_getParamName(Comment: CXComment) -> CXString { 0552 return _clang_TParamCommandComment_getParamName(Comment: Comment) 0553 } 0554 private let _clang_TParamCommandComment_getParamName
created_Documentation.swift:540 : @convention(c) (Comment: CXComment) -> CXString = library.loadSymbol("clang_TParamCommandComment_getParamName") 0555 0556 0557 0558 /** 0559 * \param Comment a \c CXComment_TParamCommand AST node. 0560 * 0561 * \returns non-zero if the parameter that this AST node represents was found 0562 * in the template parameter list and 0563 * \c clang_TParamCommandComment_getDepth and 0564 * \c clang_TParamCommandComment_getIndex functions will return a meaningful 0565 * value. 0566 */ 0567 public func clang_TParamCommandComment_isParamPositionValid(Comment: CXComment) -> UInt32 { 0568 return _clang_TParamCommandComment_isParamPositionValid(Comment: Comment) 0569 } 0570 private let _clang_TParamCommandComment_isParamPositionValid
created_Documentation.swift:552 : @convention(c) (Comment: CXComment) -> UInt32 = library.loadSymbol("clang_TParamCommandComment_isParamPositionValid") 0571 0572 0573 0574 /** 0575 * \param Comment a \c CXComment_TParamCommand AST node. 0576 * 0577 * \returns zero-based nesting depth of this parameter in the template parameter list. 0578 * 0579 * For example, 0580 * \verbatim 0581 * template<typename C, template<typename T> class TT> 0582 * void test(TT<int> aaa); 0583 * \endverbatim 0584 * for C and TT nesting depth is 0, 0585 * for T nesting depth is 1. 0586 */ 0587 public func clang_TParamCommandComment_getDepth(Comment: CXComment) -> UInt32 { 0588 return _clang_TParamCommandComment_getDepth(Comment: Comment) 0589 } 0590 private let _clang_TParamCommandComment_getDepth
created_Documentation.swift:568 : @convention(c) (Comment: CXComment) -> UInt32 = library.loadSymbol("clang_TParamCommandComment_getDepth") 0591 0592 0593 0594 /** 0595 * \param Comment a \c CXComment_TParamCommand AST node. 0596 * 0597 * \returns zero-based parameter index in the template parameter list at a 0598 * given nesting depth. 0599 * 0600 * For example, 0601 * \verbatim 0602 * template<typename C, template<typename T> class TT> 0603 * void test(TT<int> aaa); 0604 * \endverbatim 0605 * for C and TT nesting depth is 0, so we can ask for index at depth 0: 0606 * at depth 0 C's index is 0, TT's index is 1. 0607 * 0608 * For T nesting depth is 1, so we can ask for index at depth 0 and 1: 0609 * at depth 0 T's index is 1 (same as TT's), 0610 * at depth 1 T's index is 0. 0611 */ 0612 public func clang_TParamCommandComment_getIndex(Comment: CXComment, _ Depth: UInt32) -> UInt32 { 0613 return _clang_TParamCommandComment_getIndex(Comment: Comment, Depth: Depth) 0614 } 0615 private let _clang_TParamCommandComment_getIndex
created_Documentation.swift:588 : @convention(c) (Comment: CXComment, Depth: UInt32) -> UInt32 = library.loadSymbol("clang_TParamCommandComment_getIndex") 0616 0617 0618 0619 /** 0620 * \param Comment a \c CXComment_VerbatimBlockLine AST node. 0621 * 0622 * \returns text contained in the AST node. 0623 */ 0624 public func clang_VerbatimBlockLineComment_getText(Comment: CXComment) -> CXString { 0625 return _clang_VerbatimBlockLineComment_getText(Comment: Comment) 0626 } 0627 private let _clang_VerbatimBlockLineComment_getText
created_Documentation.swift:613 : @convention(c) (Comment: CXComment) -> CXString = library.loadSymbol("clang_VerbatimBlockLineComment_getText") 0628 0629 0630 /** 0631 * \param Comment a \c CXComment_VerbatimLine AST node. 0632 * 0633 * \returns text contained in the AST node. 0634 */ 0635 public func clang_VerbatimLineComment_getText
created_Documentation.swift:625 (Comment: CXComment) -> CXString { 0636 return _clang_VerbatimLineComment_getText(Comment: Comment) 0637 } 0638 private let _clang_VerbatimLineComment_getText
Clang+SourceKitten.swift:169 : @convention(c) (Comment: CXComment) -> CXString = library.loadSymbol("clang_VerbatimLineComment_getText") 0639 0640 0641 /** 0642 * \brief Convert an HTML tag AST node to string. 0643 * 0644 * \param Comment a \c CXComment_HTMLStartTag or \c CXComment_HTMLEndTag AST 0645 * node. 0646 * 0647 * \returns string containing an HTML tag. 0648 */ 0649 public func clang_HTMLTagComment_getAsString(Comment: CXComment) -> CXString { 0650 return _clang_HTMLTagComment_getAsString(Comment: Comment) 0651 } 0652 private let _clang_HTMLTagComment_getAsString
created_Documentation.swift:636 : @convention(c) (Comment: CXComment) -> CXString = library.loadSymbol("clang_HTMLTagComment_getAsString") 0653 0654 0655 /** 0656 * \brief Convert a given full parsed comment to an HTML fragment. 0657 * 0658 * Specific details of HTML layout are subject to change. Don't try to parse 0659 * this HTML back into an AST, use other APIs instead. 0660 * 0661 * Currently the following CSS classes are used: 0662 * \li "para-brief" for \\brief paragraph and equivalent commands; 0663 * \li "para-returns" for \\returns paragraph and equivalent commands; 0664 * \li "word-returns" for the "Returns" word in \\returns paragraph. 0665 * 0666 * Function argument documentation is rendered as a \<dl\> list with arguments 0667 * sorted in function prototype order. CSS classes used: 0668 * \li "param-name-index-NUMBER" for parameter name (\<dt\>); 0669 * \li "param-descr-index-NUMBER" for parameter description (\<dd\>); 0670 * \li "param-name-index-invalid" and "param-descr-index-invalid" are used if 0671 * parameter index is invalid. 0672 * 0673 * Template parameter documentation is rendered as a \<dl\> list with 0674 * parameters sorted in template parameter list order. CSS classes used: 0675 * \li "tparam-name-index-NUMBER" for parameter name (\<dt\>); 0676 * \li "tparam-descr-index-NUMBER" for parameter description (\<dd\>); 0677 * \li "tparam-name-index-other" and "tparam-descr-index-other" are used for 0678 * names inside template template parameters; 0679 * \li "tparam-name-index-invalid" and "tparam-descr-index-invalid" are used if 0680 * parameter position is invalid. 0681 * 0682 * \param Comment a \c CXComment_FullComment AST node. 0683 * 0684 * \returns string containing an HTML fragment. 0685 */ 0686 public func clang_FullComment_getAsHTML(Comment: CXComment) -> CXString { 0687 return _clang_FullComment_getAsHTML(Comment: Comment) 0688 } 0689 private let _clang_FullComment_getAsHTML
created_Documentation.swift:650 : @convention(c) (Comment: CXComment) -> CXString = library.loadSymbol("clang_FullComment_getAsHTML") 0690 0691 0692 /** 0693 * \brief Convert a given full parsed comment to an XML document. 0694 * 0695 * A Relax NG schema for the XML can be found in comment-xml-schema.rng file 0696 * inside clang source tree. 0697 * 0698 * \param Comment a \c CXComment_FullComment AST node. 0699 * 0700 * \returns string containing an XML document. 0701 */ 0702 public func clang_FullComment_getAsXML
created_Documentation.swift:687 (Comment: CXComment) -> CXString { 0703 return _clang_FullComment_getAsXML(Comment: Comment) 0704 } 0705 private let _clang_FullComment_getAsXML
Clang+SourceKitten.swift:68 : @convention(c) (Comment: CXComment) -> CXString = library.loadSymbol("clang_FullComment_getAsXML") 0706 0707
created_Documentation.swift:703