From 678c2eade46d0980ee0936781d603df01230e3d9 Mon Sep 17 00:00:00 2001 From: abitmore Date: Mon, 3 Jul 2023 11:05:19 +0000 Subject: [PATCH 1/3] Update project brief and version in Doxyfile --- Doxyfile | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Doxyfile b/Doxyfile index 7f596caf9..b876a077d 100644 --- a/Doxyfile +++ b/Doxyfile @@ -38,13 +38,13 @@ PROJECT_NAME = "BitShares-Core" # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = "6.1.0" +PROJECT_NUMBER = "7.0.0" # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a # quick idea about the purpose of the project. Keep the description short. -PROJECT_BRIEF = "BitShares blockchain implementation and command-line interface software" +PROJECT_BRIEF = "BitShares blockchain node software and command-line wallet software" # With the PROJECT_LOGO tag one can specify a logo or an icon that is included # in the documentation. The maximum height of the logo should not exceed 55 From cc9841a69bc8fa6c52dafaf75704c79816e9b596 Mon Sep 17 00:00:00 2001 From: abitmore Date: Mon, 3 Jul 2023 23:29:31 +0000 Subject: [PATCH 2/3] Fix Doxygen warnings --- libraries/chain/include/graphene/chain/asset_object.hpp | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/libraries/chain/include/graphene/chain/asset_object.hpp b/libraries/chain/include/graphene/chain/asset_object.hpp index 60b5a0fd3..38a31daff 100644 --- a/libraries/chain/include/graphene/chain/asset_object.hpp +++ b/libraries/chain/include/graphene/chain/asset_object.hpp @@ -328,7 +328,8 @@ namespace graphene { namespace chain { ///@} /// @return true if the individual settlement pool is not empty and the bitasset's black swan response method - /// (BSRM) is @ref bitasset_options::black_swan_response_type::individual_settlement_to_fund, + /// (BSRM) is @ref + /// graphene::protocol::bitasset_options::black_swan_response_type::individual_settlement_to_fund, /// false otherwise bool is_individually_settled_to_fund()const { From 311c6a21382cb1da1674b6ff6d0aa7c226f39b98 Mon Sep 17 00:00:00 2001 From: abitmore Date: Wed, 12 Jul 2023 20:24:26 +0000 Subject: [PATCH 3/3] Fix gethelp command in CLI wallet --- .../wallet/generate_api_documentation.pl | 23 +++++++++++++------ 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/libraries/wallet/generate_api_documentation.pl b/libraries/wallet/generate_api_documentation.pl index a51558239..fd985b247 100755 --- a/libraries/wallet/generate_api_documentation.pl +++ b/libraries/wallet/generate_api_documentation.pl @@ -16,7 +16,7 @@ #include namespace graphene { namespace wallet { - namespace detail + namespace detail { struct api_method_name_collector_visitor { @@ -29,7 +29,7 @@ } }; } - + api_documentation::api_documentation() { END @@ -110,17 +110,26 @@ sub formatDocComment for (my $i = 0; $i < @{$doc}; ++$i) { - if ($doc->[$i] eq 'params') + if (($doc->[$i] eq 'params') # doxygen version 1.8.11 (Ubuntu 16.04) or 1.8.13 (Ubuntu 18.04) + or ($doc->[$i]->{params})) # doxygen version 1.8.17 (Ubuntu 20.04) { $paramDocs .= "Parameters:\n"; - @parametersList = @{$doc->[$i + 1]}; + if ($doc->[$i] eq 'params') + { + ++$i; + @parametersList = @{$doc->[$i]}; + } + else + { + @parametersList = @{$doc->[$i]->{params}}; + } for my $parameter (@parametersList) { my $declname = $parameter->{parameters}->[0]->{name}; my $decltype = cleanupDoxygenType($paramInfo->{$declname}->{type}); - $paramDocs .= Text::Wrap::fill(' ', ' ', "$declname: " . formatDocComment($parameter->{doc}) . " (type: $decltype)") . "\n"; + $paramDocs .= Text::Wrap::fill(' ', ' ', "$declname: " . formatDocComment($parameter->{doc}) + . " (type: $decltype)") . "\n"; } - ++$i; } elsif ($doc->[$i]->{return}) { @@ -154,7 +163,7 @@ sub formatDocComment my $result = Text::Wrap::fill('', '', $bodyDocs); $result .= "\n\n" . $paramDocs if $paramDocs; $result .= "\n\n" . $returnDocs if $returnDocs; - + return $result; }