chore(doxygen): modify config and add commenting examples to doc

.gitignore

@@ -27,4 +27,7 @@ libraries/config/include/config/version.hpp
 __pycache__/
 
 # do not include into git chart dependencies
-charts/*/charts/*.tgz
+charts/*/charts/*.tgz
+
+# do not include generated documentation
+doxygen_docs

Doxyfile

@@ -504,7 +504,7 @@ EXTRACT_ALL            = YES
 # be included in the documentation.
 # The default value is: NO.
 
-EXTRACT_PRIVATE        = NO
+EXTRACT_PRIVATE        = YES
 
 # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
 # methods of a class will be included in the documentation.
@@ -522,7 +522,7 @@ EXTRACT_PACKAGE        = NO
 # included in the documentation.
 # The default value is: NO.
 
-EXTRACT_STATIC         = NO
+EXTRACT_STATIC         = YES
 
 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
 # locally in source files will be included in the documentation. If set to NO,
@@ -1598,7 +1598,7 @@ DISABLE_INDEX          = NO
 # The default value is: NO.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-GENERATE_TREEVIEW      = NO
+GENERATE_TREEVIEW      = YES
 
 # When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the
 # FULL_SIDEBAR option determines if the side bar is limited to only the treeview
@@ -2539,7 +2539,7 @@ CALLER_GRAPH           = NO
 # The default value is: YES.
 # This tag requires that the tag HAVE_DOT is set to YES.
 
-GRAPHICAL_HIERARCHY    = NO
+GRAPHICAL_HIERARCHY    = YES
 
 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
 # dependencies a directory has on other directories in a graphical way. The

doc/doxygen.md

@@ -15,4 +15,51 @@ brew install doxygen graphviz
 
 ## Generating documentation
 
-To generate documentation you need to call `doxygen` from project source root. It should generate all needed files in `doxygen_docs` folder. You can open `index.html` in your browser to check result.
+To generate documentation you need to call `doxygen` from project source root. It should generate all needed files in `doxygen_docs` folder. You can open `index.html` in your browser to check result.
+
+## Commenting 
+
+Full description on [doxygen site](https://www.doxygen.nl/manual/docblocks.html)
+
+### Basic example
+
+```cpp
+/** @brief Brief description which ends at this dot. 
+ *
+ * Details follows here.
+ * @see anotherMethod()
+ * @param param1 description
+ * @param params2 description
+ * @return return value description
+ */
+```
+
+### Grouping to modules 
+
+We should also group code to modules, so it will be easier to navigate in documentation. Class with all methods would be added as `Test` module. Example:
+
+```cpp
+/** @addtogroup Test
+ * @{
+ */
+
+class TestClass {}
+
+/**
+ * @}
+ */
+```
+
+### Graphs 
+
+Collaboration diagrams enabled by default for all classes. Additionally we could add `call graph` and `caller graph` for functions and method. To do that you need to specify additional attributes to comment:
+
+
+```cpp
+/**
+* @callergraph 
+* @callgraph
+* @brief brief description of function or method 
+....
+*/
+```

libraries/core_libs/consensus/include/dag/block_proposer.hpp

@@ -12,7 +12,7 @@
 
 namespace taraxa {
 
-/** \addtogroup DAG
+/** @addtogroup DAG
  * @{
  */
 

libraries/core_libs/consensus/include/dag/dag.hpp

@@ -30,7 +30,7 @@
 #include "transaction/transaction_manager.hpp"
 namespace taraxa {
 
-/** \addtogroup DAG
+/** @addtogroup DAG
  * @{
  */
 class DagManager;

libraries/core_libs/consensus/include/dag/dag_block_manager.hpp

@@ -9,7 +9,7 @@
 #include "vdf/sortition.hpp"
 
 namespace taraxa {
-/** \addtogroup DAG
+/** @addtogroup DAG
  * @{
  */
 

libraries/core_libs/consensus/include/dag/sortition_params_manager.hpp

@@ -8,7 +8,7 @@ namespace taraxa {
 
 using EfficienciesMap = std::map<uint16_t, int32_t>;
 
-/** \addtogroup DAG
+/** @addtogroup DAG
  * @{
  */
 

libraries/core_libs/consensus/include/final_chain/data.hpp

@@ -15,7 +15,7 @@
 
 namespace taraxa::final_chain {
 
-/** \addtogroup FinalChain
+/** @addtogroup FinalChain
  * @{
  */
 

libraries/core_libs/consensus/include/final_chain/final_chain.hpp

@@ -12,7 +12,7 @@
 
 namespace taraxa::final_chain {
 
-/** \addtogroup FinalChain
+/** @addtogroup FinalChain
  * @{
  */
 

libraries/core_libs/consensus/include/final_chain/replay_protection_service.hpp

@@ -7,7 +7,7 @@
 
 namespace taraxa::final_chain {
 
-/** \addtogroup FinalChain
+/** @addtogroup FinalChain
  * @{
  */
 

libraries/core_libs/consensus/include/final_chain/state_api.hpp

@@ -10,7 +10,7 @@
 
 namespace taraxa::state_api {
 
-/** \addtogroup FinalChain
+/** @addtogroup FinalChain
  * @{
  */
 

libraries/core_libs/consensus/include/final_chain/state_api_data.hpp

@@ -12,7 +12,7 @@
 
 namespace taraxa::state_api {
 
-/** \addtogroup FinalChain
+/** @addtogroup FinalChain
  * @{
  */
 

libraries/core_libs/consensus/include/pbft/pbft_chain.hpp

@@ -11,7 +11,7 @@
 
 namespace taraxa {
 
-/** \addtogroup PBFT
+/** @addtogroup PBFT
  * @{
  */
 

libraries/core_libs/consensus/include/pbft/pbft_manager.hpp

@@ -19,7 +19,7 @@
 
 namespace taraxa {
 
-/** \addtogroup PBFT
+/** @addtogroup PBFT
  * @{
  */
 

libraries/core_libs/consensus/include/pbft/sync_queue.hpp

@@ -8,7 +8,7 @@
 
 namespace taraxa {
 
-/** \addtogroup PBFT
+/** @addtogroup PBFT
  * @{
  */
 

libraries/core_libs/consensus/include/transaction/gas_pricer.hpp

@@ -6,7 +6,7 @@
 
 namespace taraxa {
 
-/** \addtogroup Transaction
+/** @addtogroup Transaction
  * @{
  */
 

libraries/core_libs/consensus/include/transaction/transaction_manager.hpp

@@ -10,7 +10,7 @@
 
 namespace taraxa {
 
-/** \addtogroup Transaction
+/** @addtogroup Transaction
  * @{
  */
 

libraries/core_libs/consensus/include/transaction/transaction_queue.hpp

@@ -4,7 +4,7 @@
 
 namespace taraxa {
 
-/** \addtogroup Transaction
+/** @addtogroup Transaction
  * @{
  */
 

libraries/core_libs/consensus/include/vote_manager/vote_manager.hpp

@@ -6,7 +6,7 @@
 
 namespace taraxa {
 
-/** \addtogroup Vote
+/** @addtogroup Vote
  * @{
  */