matthias/clang-uml
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added doxygen comments to common namespace

Browse Source
This commit is contained in:
Bartek Kryza
2023-06-18 20:23:29 +02:00
parent da2cb63ab3
commit f424ed4c8c
63 changed files with 1063 additions and 171 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/common/generators/generators.cc
View File

@@ -1,5 +1,5 @@
/**
* src/common/generators/generators.cc
* @file src/common/generators/generators.cc
*
* Copyright (c) 2021-2023 Bartek Kryza <bkryza@gmail.com>
*

2
src/common/generators/generators.h
View File

@@ -1,5 +1,5 @@
/**
* src/common/generators/generators.h
* @file src/common/generators/generators.h
*
* Copyright (c) 2021-2023 Bartek Kryza <bkryza@gmail.com>
*

2
src/common/generators/json/generator.cc
View File

@@ -1,5 +1,5 @@
/**
* src/common/generators/json/generator.cc
* @file src/common/generators/json/generator.cc
*
* Copyright (c) 2021-2023 Bartek Kryza <bkryza@gmail.com>
*

2
src/common/generators/json/generator.h
View File

@@ -1,5 +1,5 @@
/**
* src/common/generators/json/generator.h
* @file src/common/generators/json/generator.h
*
* Copyright (c) 2021-2023 Bartek Kryza <bkryza@gmail.com>
*

22
src/common/generators/nested_element_stack.h
View File

@@ -1,5 +1,5 @@
/**
* src/common/generators/nested_element_stack.h
* @file src/common/generators/nested_element_stack.h
*
* Copyright (c) 2021-2023 Bartek Kryza <bkryza@gmail.com>
*
@@ -38,6 +38,9 @@ public:
current_level_groups_.push_back({});
}
/**
* Switch to next level in the element stack
*/
void enter()
{
if (!is_flat_)
@@ -46,6 +49,9 @@ public:
current_level_groups_.push_back({});
}
/**
* Switch to previous level in the element stack
*/
void leave()
{
if (!is_flat_)
@@ -54,16 +60,30 @@ public:
current_level_groups_.pop_back();
}
/**
* Add element pointer to a specified group at the current level
*/
void group_together(const std::string &group_name, T *e)
{
current_level_groups_[current_level_][group_name].push_back(e);
}
/**
* Get map of element groups at the current level.
*
* @return Reference to element groups.
*/
const std::map<std::string, std::vector<T *>> &get_current_groups()
{
return current_level_groups_.at(current_level_);
}
/**
* Get element group by name - the group must exist at the current level.
*
* @param group_name Element group name
* @return
*/
const std::vector<T *> &get_group(const std::string &group_name)
{
return get_current_groups().at(group_name);

2
src/common/generators/plantuml/generator.cc
View File

@@ -1,5 +1,5 @@
/**
* src/common/generators/plantuml/generator.h
* @file src/common/generators/plantuml/generator.h
*
* Copyright (c) 2021-2023 Bartek Kryza <bkryza@gmail.com>
*

2
src/common/generators/plantuml/generator.h
View File

@@ -1,5 +1,5 @@
/**
* src/common/generators/plantuml/generator.h
* @file src/common/generators/plantuml/generator.h
*
* Copyright (c) 2021-2023 Bartek Kryza <bkryza@gmail.com>
*

2
src/common/generators/progress_indicator.cc
View File

@@ -1,5 +1,5 @@
/**
* src/common/generators/progress_indicator.cc
* @file src/common/generators/progress_indicator.cc
*
* Copyright (c) 2021-2023 Bartek Kryza <bkryza@gmail.com>
*

30
src/common/generators/progress_indicator.h
View File

@@ -1,5 +1,5 @@
/**
* src/common/generators/progress_indicator.h
* @file src/common/generators/progress_indicator.h
*
* Copyright (c) 2021-2023 Bartek Kryza <bkryza@gmail.com>
*
@@ -25,6 +25,9 @@
namespace clanguml::common::generators {
/**
* @brief Container for diagram generation progress indicators
*/
class progress_indicator {
public:
struct progress_state {
@@ -42,15 +45,40 @@ public:
progress_indicator();
/**
* Add a new progress bar to the indicator set
*
* @param name Name (prefix) of the progress bar
* @param max Total number of steps in the progress bar
* @param color Color of the progress bar
*/
void add_progress_bar(
const std::string &name, size_t max, indicators::Color color);
/**
* Increment specified progress bar.
*
* @param name Name of the progress bar
*/
void increment(const std::string &name);
/**
* Stop all the progress bars.
*/
void stop();
/**
* Set specified progress bar as complete.
*
* @param name Name of the progress bar
*/
void complete(const std::string &name);
/**
* Set progress bar as failed.
*
* @param name Name of the progress bar
*/
void fail(const std::string &name);
private: