Describe a named C++ scope in terms of its place in a file, the namespaces it occupies, and any annotation that appears to be associated with it. More...

#include <code_dox.h>

Public Member Functions
	CppScope (const std::string &filename_in)
	Constructor for a C++ scope struct.

	~CppScope ()=default
	Default destructor.

Public Attributes
int	start_line
	Line at which this scope starts.

int	start_pos
	Position on the line at which this scope starts.

int	end_line
	Line at which this scope ends.

int	end_pos
	Position on the line at which this scope ends.

std::string	scope_name

std::string	file_name
	File name in which this scope is found.

std::vector< std::string >	namespaces

Detailed Description

Describe a named C++ scope in terms of its place in a file, the namespaces it occupies, and any annotation that appears to be associated with it.

Constructor & Destructor Documentation

◆ CppScope()

stormm::docs::CppScope::CppScope ( const std::string & filename_in )

Constructor for a C++ scope struct.

Parameters

filename_in Name of the file being searched

Member Data Documentation

◆ namespaces

std::vector<std::string> stormm::docs::CppScope::namespaces

Namespaces in which this scope exists (namespaces are not recorded as named scopes in their own right)

◆ scope_name

std::string stormm::docs::CppScope::scope_name

Name of the scope (only structs, classes, and functions will be named, and thus recorded)

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

src/Reporting/code_dox.h
src/Reporting/code_dox.cpp