Added initial Doxygen config
This commit is contained in:
@@ -22,6 +22,9 @@
|
||||
|
||||
namespace clanguml::common::model {
|
||||
|
||||
/**
|
||||
* @brief Base class of all diagram elements that have source location.
|
||||
*/
|
||||
class source_location {
|
||||
public:
|
||||
source_location() = default;
|
||||
@@ -32,31 +35,96 @@ public:
|
||||
{
|
||||
}
|
||||
|
||||
/**
|
||||
* Return absolute source file path.
|
||||
*
|
||||
* @return Absolute file path.
|
||||
*/
|
||||
const std::string &file() const { return file_; }
|
||||
|
||||
/**
|
||||
* Set absolute file path.
|
||||
*
|
||||
* @param file Absolute file path.
|
||||
*/
|
||||
void set_file(const std::string &file) { file_ = file; }
|
||||
|
||||
/**
|
||||
* Return source file path relative to `relative_to` config option.
|
||||
*
|
||||
* @return Relative file path.
|
||||
*/
|
||||
const std::string &file_relative() const { return file_relative_; }
|
||||
|
||||
/**
|
||||
* Set relative file path.
|
||||
*
|
||||
* @param file Relative file path.
|
||||
*/
|
||||
void set_file_relative(const std::string &file) { file_relative_ = file; }
|
||||
|
||||
/**
|
||||
* Get the translation unit, from which this source location was visited.
|
||||
*
|
||||
* @return Path to the translation unit.
|
||||
*/
|
||||
const std::string &translation_unit() const { return translation_unit_; }
|
||||
|
||||
/**
|
||||
* Set the path to translation unit, from which this source location was
|
||||
* visited.
|
||||
*
|
||||
* @param translation_unit Path to the translation unit.
|
||||
*/
|
||||
void set_translation_unit(const std::string &translation_unit)
|
||||
{
|
||||
translation_unit_ = translation_unit;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the source location line number.
|
||||
*
|
||||
* @return Line number.
|
||||
*/
|
||||
unsigned int line() const { return line_; }
|
||||
|
||||
/**
|
||||
* Set the source location line number.
|
||||
*
|
||||
* @param line Line number.
|
||||
*/
|
||||
void set_line(const unsigned line) { line_ = line; }
|
||||
|
||||
/**
|
||||
* Get the source location column number.
|
||||
*
|
||||
* @return Column number.
|
||||
*/
|
||||
unsigned int column() const { return column_; }
|
||||
|
||||
/**
|
||||
* Set the source location column number.
|
||||
*
|
||||
* @param line Column number.
|
||||
*/
|
||||
void set_column(const unsigned column) { column_ = column; }
|
||||
|
||||
/**
|
||||
* Get the source location id.
|
||||
*
|
||||
* The location id is equivalent to Clang's SourceLocation::getHashValue()
|
||||
*
|
||||
* @return Location id.
|
||||
*/
|
||||
unsigned int location_id() const { return hash_; }
|
||||
|
||||
/**
|
||||
* Set the source location id.
|
||||
*
|
||||
* The location id is equivalent to Clang's SourceLocation::getHashValue()
|
||||
*
|
||||
* @param h Location id.
|
||||
*/
|
||||
void set_location_id(unsigned int h) { hash_ = h; }
|
||||
|
||||
private:
|
||||
|
||||
Reference in New Issue
Block a user