bypass-core-1.0
Bypass::Document Class Reference

An object that serves as the root of a markdown Element tree. More...

#include <src/document.h>

Public Member Functions

 Document ()
 Creates a new Document.
 
 ~Document ()
 Destroys the Document.
 
void append (const Element &element)
 Appends the given element to the tail of this document.
 
Element operator[] (size_t i)
 Allows for sequentially accessing elements in this Document tree.
 
size_t size ()
 Indicates the number of elements in this Document.
 

Detailed Description

An object that serves as the root of a markdown Element tree.

Constructor & Destructor Documentation

Bypass::Document::Document ( )

Creates a new Document.

Bypass::Document::~Document ( )

Destroys the Document.

Member Function Documentation

void Bypass::Document::append ( const Element element)

Appends the given element to the tail of this document.

Parameters
elementThe element to append to the tail.
Element Bypass::Document::operator[] ( size_t  i)

Allows for sequentially accessing elements in this Document tree.

Parameters
iThe index of the element to retrieve.
Returns
Element The element at the given index.
size_t Bypass::Document::size ( )

Indicates the number of elements in this Document.

Returns
The number of elements.

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