Static Public Member Functions | Public Attributes | List of all members
Issue Struct Reference

#include <texttools.h>

Detailed Description

An issue found in the dox files or code snippets.

Static Public Member Functions

static Issue MakeIssue (const String &desc, const Url &file, const String &source, const Int line=0)
 

Public Attributes

String _description
 
Url _file
 
String _source
 
Int _line
 

Member Function Documentation

◆ MakeIssue()

static Issue MakeIssue ( const String &  desc,
const Url &  file,
const String &  source,
const Int  line = 0 
)
static

Creates a new Issue instance.

Parameters
[in]descThe description.
[in]fileThe file the issue was found in.
[in]sourceThe source code line the issue was found.
[in]lineThe line number in the source file.
Returns
The new Issue object.

Member Data Documentation

◆ _description

String _description

description of the issue

◆ _file

Url _file

file were the issue was found

◆ _source

String _source

the actual source code with the issue

◆ _line

Int _line

line number in the source file