clang::extractapi Namespace Reference

Classes
struct	APIIgnoresList
	A type that provides access to a new line separated list of symbol names to ignore when extracting API information. More...
struct	APIRecord
	The base representation of an API record. Holds common symbol information. More...
class	APISerializer
	The base interface of serializers for API information. More...
struct	APISerializerOption
	Common options to customize the serializer output. More...
class	APISet
	APISet holds the set of API records collected from given inputs. More...
struct	AvailabilityInfo
	Stores availability attributes of a symbol in a given domain. More...
class	AvailabilitySet
class	DeclarationFragments
	DeclarationFragments is a vector of tagged important parts of a symbol's declaration. More...
class	DeclarationFragmentsBuilder
	A factory class to build DeclarationFragments for different kinds of Decl. More...
struct	EnumConstantRecord
	This holds information associated with enum constants. More...
struct	EnumRecord
	This holds information associated with enums. More...
class	ExtractAPIVisitor
	The RecursiveASTVisitor to traverse symbol declarations and collect API information. More...
class	FunctionSignature
	Store function signature information with DeclarationFragments of the return type and parameters. More...
struct	GlobalFunctionRecord
	This holds information associated with global functions. More...
struct	GlobalVariableRecord
	This holds information associated with global functions. More...
struct	has_function_signature
	Check if a record type has a function signature mixin. More...
struct	has_function_signature< GlobalFunctionRecord >
struct	has_function_signature< ObjCClassMethodRecord >
struct	has_function_signature< ObjCInstanceMethodRecord >
struct	has_function_signature< ObjCMethodRecord >
struct	IgnoresFileNotFound
struct	MacroDefinitionRecord
	This holds information associated with macro definitions. More...
struct	ObjCCategoryRecord
	This holds information associated with Objective-C categories. More...
struct	ObjCClassMethodRecord
struct	ObjCClassPropertyRecord
struct	ObjCContainerRecord
	The base representation of an Objective-C container record. More...
struct	ObjCInstanceMethodRecord
struct	ObjCInstancePropertyRecord
struct	ObjCInstanceVariableRecord
	This holds information associated with Objective-C instance variables. More...
struct	ObjCInterfaceRecord
	This holds information associated with Objective-C interfaces/classes. More...
struct	ObjCMethodRecord
	This holds information associated with Objective-C methods. More...
struct	ObjCPropertyRecord
	This holds information associated with Objective-C properties. More...
struct	ObjCProtocolRecord
	This holds information associated with Objective-C protocols. More...
struct	StructFieldRecord
	This holds information associated with struct fields. More...
struct	StructRecord
	This holds information associated with structs. More...
class	SymbolGraphSerializer
	The serializer that organizes API information in the Symbol Graph format. More...
struct	SymbolReference
	This represents a reference to another symbol that might come from external sources. More...
struct	TypedefRecord
	This holds information associated with typedefs. More...
struct	TypedefUnderlyingTypeResolver

Typedefs
using	DocComment = std::vector< RawComment::CommentLine >
	DocComment is a vector of RawComment::CommentLine.

Typedef Documentation

DocComment

using clang::extractapi::DocComment = typedef std::vector<RawComment::CommentLine>

DocComment is a vector of RawComment::CommentLine.

Each line represents one line of striped documentation comment, with source range information. This simplifies calculating the source location of a character in the doc comment for pointing back to the source file. e.g.

/// This is a documentation comment
    ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~'  First line.
///     with multiple lines.
    ^~~~~~~~~~~~~~~~~~~~~~~'         Second line.

Definition at line 51 of file API.h.