clang::extractapi::APISerializer Class Reference

The base interface of serializers for API information. More...

#include "clang/ExtractAPI/Serialization/SerializerBase.h"

Inheritance diagram for clang::extractapi::APISerializer:

Collaboration diagram for clang::extractapi::APISerializer:

Public Member Functions
virtual void	serialize (raw_ostream &os)=0
	Serialize the API information to os.
	APISerializer ()=delete
	APISerializer (const APISerializer &)=delete
	APISerializer (APISerializer &&)=delete
APISerializer &	operator= (const APISerializer &)=delete
APISerializer &	operator= (APISerializer &&)=delete

Protected Member Functions
	APISerializer (const APISet &API, const APIIgnoresList &IgnoresList, APISerializerOption Options={})
virtual	~APISerializer ()=default

Protected Attributes
const APISet &	API
const APIIgnoresList &	IgnoresList
	The list of symbols to ignore.
APISerializerOption	Options

Detailed Description

The base interface of serializers for API information.

Definition at line 31 of file SerializerBase.h.

Constructor & Destructor Documentation

APISerializer() [1/4]

clang::extractapi::APISerializer::APISerializer ( )

delete

APISerializer() [2/4]

clang::extractapi::APISerializer::APISerializer ( const APISerializer &  )

delete

APISerializer() [3/4]

clang::extractapi::APISerializer::APISerializer ( APISerializer &&  )

delete

APISerializer() [4/4]

clang::extractapi::APISerializer::APISerializer ( const APISet &  API, const APIIgnoresList &  IgnoresList, APISerializerOption  Options = {}  )

inlineprotected

Definition at line 54 of file SerializerBase.h.

~APISerializer()

virtual clang::extractapi::APISerializer::~APISerializer ( )

protectedvirtualdefault

Member Function Documentation

operator=() [1/2]

APISerializer & clang::extractapi::APISerializer::operator= ( APISerializer &&  )

delete

operator=() [2/2]

APISerializer & clang::extractapi::APISerializer::operator= ( const APISerializer &  )

delete

serialize()

void APISerializer::serialize ( raw_ostream &  os )

pure virtual

Serialize the API information to os.

Implemented in clang::extractapi::SymbolGraphSerializer.

Definition at line 19 of file SerializerBase.cpp.

Member Data Documentation

API

const APISet& clang::extractapi::APISerializer::API

protected

Definition at line 37 of file SerializerBase.h.

Referenced by clang::extractapi::SymbolGraphSerializer::serialize(), and clang::extractapi::SymbolGraphSerializer::serializeSingleSymbolSGF().

IgnoresList

const APIIgnoresList& clang::extractapi::APISerializer::IgnoresList

protected

The list of symbols to ignore.

Note: This should be consulted before emitting a symbol.

Definition at line 42 of file SerializerBase.h.

Options

APISerializerOption clang::extractapi::APISerializer::Options

protected

Definition at line 44 of file SerializerBase.h.

Referenced by clang::extractapi::SymbolGraphSerializer::serialize().

---

The documentation for this class was generated from the following files:

• include/clang/ExtractAPI/Serialization/SerializerBase.h
• lib/ExtractAPI/Serialization/SerializerBase.cpp