Skip to content

Commit

Permalink
Doxygen: fix broken links
Browse files Browse the repository at this point in the history
  • Loading branch information
0xFFFC0000 authored and justindhillon committed Feb 21, 2024
1 parent 36addc1 commit de10cc4
Show file tree
Hide file tree
Showing 10 changed files with 39 additions and 45 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/copyright.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
name: ci/gh-actions/copyright
on:
workflow_dispatch:
schedule:
- cron: '0 0 1 1 *'
jobs:
Expand Down Expand Up @@ -45,7 +46,7 @@ jobs:
token: ${{ secrets.GITHUB_TOKEN }}
commit-message: "Copyright: Update to ${{ env.YEAR }}"
committer: GitHub <noreply@github.com>
author: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>
author: copyCat <copy@Cat.com>
signoff: false
branch: bump-copyright-year
delete-branch: true
Expand Down
5 changes: 3 additions & 2 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,9 @@ include(CheckCXXCompilerFlag)
include(CheckLinkerFlag)
include(CheckLibraryExists)
include(CheckFunctionExists)

cmake_policy(SET CMP0148 OLD)
if (POLICY CMP0148)
cmake_policy(SET CMP0148 OLD) # https://cmake.org/cmake/help/latest/policy/CMP0148.html
endif()
include(FindPythonInterp)

if (IOS)
Expand Down
10 changes: 5 additions & 5 deletions Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -1152,12 +1152,12 @@ HTML_INDEX_NUM_ENTRIES = 100

# If the GENERATE_DOCSET tag is set to YES, additional index files will be
# generated that can be used as input for Apple's Xcode 3 integrated development
# environment (see: https://developer.apple.com/tools/xcode/), introduced with
# environment (see: https://developer.apple.com/xcode/), introduced with
# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
# Makefile in the HTML output directory. Running make will produce the docset in
# that directory and running make install will install the docset in
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
# startup. See https://developer.apple.com/tools/creatingdocsetswithdoxygen.html
# startup. See https://developer.apple.com/xcode/resources/
# for more information.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
Expand Down Expand Up @@ -1197,7 +1197,7 @@ DOCSET_PUBLISHER_NAME = Publisher
# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on
# (see: https://learn.microsoft.com/en-us/previous-versions/windows/desktop/htmlhelp/microsoft-html-help-downloads) on
# Windows.
#
# The HTML Help Workshop contains a compiler that can convert all HTML output
Expand Down Expand Up @@ -1423,7 +1423,7 @@ USE_MATHJAX = NO

# When MathJax is enabled you can set the default output format to be used for
# the MathJax output. See the MathJax site (see:
# https://docs.mathjax.org/en/latest/output.html) for more details.
# https://docs.mathjax.org/en/latest/web/components/output.html) for more details.
# Possible values are: HTML-CSS (which is slower, but has the best
# compatibility), NativeMML (i.e. MathML) and SVG.
# The default value is: HTML-CSS.
Expand Down Expand Up @@ -1453,7 +1453,7 @@ MATHJAX_EXTENSIONS =

# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
# of code that will be used on startup of the MathJax code. See the MathJax site
# (see: https://docs.mathjax.org/en/latest/output.html) for more details. For an
# (see: https://docs.mathjax.org/en/latest/web/components/output.html) for more details. For an
# example see the documentation.
# This tag requires that the tag USE_MATHJAX is set to YES.

Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ release-all:
release-static:
mkdir -p $(builddir)/release
cd $(builddir)/release && cmake -D STATIC=ON -D ARCH="x86-64" -D BUILD_64=ON -D CMAKE_BUILD_TYPE=Release $(topdir) && $(MAKE)
cd $(builddir)/release && cmake -D STATIC=ON -D BUILD_64=ON -D CMAKE_BUILD_TYPE=Release $(topdir) && $(MAKE)
coverage:
mkdir -p $(builddir)/debug
Expand Down
2 changes: 1 addition & 1 deletion cmake/Doxyfile.in
Original file line number Diff line number Diff line change
Expand Up @@ -981,7 +981,7 @@ HTML_INDEX_NUM_ENTRIES = 100
# directory and running "make install" will install the docset in
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
# it at startup.
# See https://developer.apple.com/tools/creatingdocsetswithdoxygen.html
# See https://developer.apple.com/xcode/resources/
# for more information.

GENERATE_DOCSET = NO
Expand Down
1 change: 1 addition & 0 deletions contrib/epee/include/net/http_base.h
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
#include <string>
#include <utility>
#include <list>
#include <stdint.h>

#undef MONERO_DEFAULT_LOG_CATEGORY
#define MONERO_DEFAULT_LOG_CATEGORY "net.http"
Expand Down
2 changes: 2 additions & 0 deletions contrib/epee/include/storages/portable_storage_from_bin.h
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,7 @@ namespace epee
default:
CHECK_AND_ASSERT_THROW_MES(false, "unknown entry_type code = " << type);
}
return read_ae<int8_t>(); // unreachable, dummy return to avoid compiler warning
}

inline
Expand Down Expand Up @@ -322,6 +323,7 @@ namespace epee
default:
CHECK_AND_ASSERT_THROW_MES(false, "unknown entry_type code = " << ent_type);
}
return read_se<int8_t>(); // unreachable, dummy return to avoid compiler warning
}
inline
void throwable_buffer_reader::read(section& sec)
Expand Down
2 changes: 1 addition & 1 deletion external/db_drivers/liblmdb/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -863,7 +863,7 @@ HTML_DYNAMIC_SECTIONS = NO
# directory and running "make install" will install the docset in
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
# it at startup.
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
# See https://developer.apple.com/xcode/resources/
# for more information.

GENERATE_DOCSET = NO
Expand Down
44 changes: 10 additions & 34 deletions src/common/dns_utils.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@

#include "common/dns_utils.h"
// check local first (in the event of static or in-source compilation of libunbound)
#include "misc_language.h"
#include "unbound.h"

#include <deque>
Expand Down Expand Up @@ -195,36 +196,7 @@ boost::optional<std::string> tlsa_to_string(const char* src, size_t len)
return boost::none;
return std::string(src, len);
}

// custom smart pointer.
// TODO: see if std::auto_ptr and the like support custom destructors
template<typename type, void (*freefunc)(type*)>
class scoped_ptr
{
public:
scoped_ptr():
ptr(nullptr)
{
}
scoped_ptr(type *p):
ptr(p)
{
}
~scoped_ptr()
{
freefunc(ptr);
}
operator type *() { return ptr; }
type **operator &() { return &ptr; }
type *operator->() { return ptr; }
operator const type*() const { return &ptr; }

private:
type* ptr;
};

typedef class scoped_ptr<ub_result,ub_resolve_free> ub_result_ptr;


struct DNSResolverData
{
ub_ctx* m_ub_context;
Expand Down Expand Up @@ -327,10 +299,14 @@ std::vector<std::string> DNSResolver::get_record(const std::string& url, int rec
std::vector<std::string> addresses;
dnssec_available = false;
dnssec_valid = false;

// destructor takes care of cleanup
ub_result_ptr result;


ub_result *result;
// Make sure we are cleaning after result.
epee::misc_utils::auto_scope_leave_caller scope_exit_handler =
epee::misc_utils::create_scope_leave_handler([&](){
ub_resolve_free(result);
});

MDEBUG("Performing DNSSEC " << get_record_name(record_type) << " record query for " << url);

// call DNS resolver, blocking. if return value not zero, something went wrong
Expand Down
13 changes: 13 additions & 0 deletions utils/gpg_keys/0xfffc0000.asc
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
-----BEGIN PGP PUBLIC KEY BLOCK-----

mDMEZZx2rhYJKwYBBAHaRw8BAQdADWrpnGYQMJB7m7OYO5QhLPbNZckNDp5XXX5C
NRqQSv60ITB4ZmZmYzAwMDAgPDB4ZmZmYzAwMDBAcHJvdG9uLm1lPoiTBBMWCgA7
FiEESleXwQVNMqPAAcfxZQ98K3vaOBkFAmWcdq4CGwMFCwkIBwICIgIGFQoJCAsC
BBYCAwECHgcCF4AACgkQZQ98K3vaOBmm6QEA1l5FuxR7MtER+pl4XiL+UEH4rGjQ
BHTD/Tv6Ar6uq2oA/34XecxRCKmj4ximF1aMucJSvS8nIjRbRQ9E5llcLOYMuDgE
ZZx2rhIKKwYBBAGXVQEFAQEHQIxFNA2STqB1WQNDtPHalCrKOBxheB6Lg1U+ceOF
rTFcAwEIB4h4BBgWCgAgFiEESleXwQVNMqPAAcfxZQ98K3vaOBkFAmWcdq4CGwwA
CgkQZQ98K3vaOBnZ2gEAsrARrt+Mm+zfqVFZ7iAQHD5xmdj9Q0Qf3zl5dVbkFlQB
APOdwpn/iY0zA6McjZ1H+Uiv+bw8uTVZadgjtJGb474O
=J9WU
-----END PGP PUBLIC KEY BLOCK-----

0 comments on commit de10cc4

Please sign in to comment.