diff options
| author | Sawyer Billings <sawpaw19@gmail.com> | 2020-12-30 21:49:12 -0500 |
|---|---|---|
| committer | fanquake <fanquake@gmail.com> | 2021-01-04 12:23:16 +0800 |
| commit | e8640849c775efcf202dbd34736fed8d61379c49 (patch) | |
| tree | 61f54fc033bdd157d33e6afd89a96c929592beb3 /doc/developer-notes.md | |
| parent | f52f427b8eece858844c395e47c378864acc242d (diff) | |
| download | bitcoin-e8640849c775efcf202dbd34736fed8d61379c49.tar.xz | |
doc: Use https URLs where possible
Diffstat (limited to 'doc/developer-notes.md')
| -rw-r--r-- | doc/developer-notes.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/developer-notes.md b/doc/developer-notes.md index e53fc1d9d6..596f65cf10 100644 --- a/doc/developer-notes.md +++ b/doc/developer-notes.md @@ -135,7 +135,7 @@ Refer to [/test/functional/README.md#style-guidelines](/test/functional/README.m Coding Style (Doxygen-compatible comments) ------------------------------------------ -Bitcoin Core uses [Doxygen](http://www.doxygen.nl/) to generate its official documentation. +Bitcoin Core uses [Doxygen](https://www.doxygen.nl/) to generate its official documentation. Use Doxygen-compatible comment blocks for functions, methods, and fields. @@ -156,7 +156,7 @@ For example, to describe a function use: bool function(int arg1, const char *arg2, std::string& arg3) ``` -A complete list of `@xxx` commands can be found at http://www.doxygen.nl/manual/commands.html. +A complete list of `@xxx` commands can be found at https://www.doxygen.nl/manual/commands.html. As Doxygen recognizes the comments by the delimiters (`/**` and `*/` in this case), you don't *need* to provide any commands for a comment to be valid; just a description text is fine. @@ -203,7 +203,7 @@ Also not picked up by Doxygen: */ ``` -A full list of comment syntaxes picked up by Doxygen can be found at http://www.doxygen.nl/manual/docblocks.html, +A full list of comment syntaxes picked up by Doxygen can be found at https://www.doxygen.nl/manual/docblocks.html, but the above styles are favored. Recommendations: @@ -216,7 +216,7 @@ Recommendations: - Backticks aren't required when referring to functions Doxygen already knows about; it will build hyperlinks for these automatically. See - http://www.doxygen.nl/manual/autolink.html for complete info. + https://www.doxygen.nl/manual/autolink.html for complete info. - Avoid linking to external documentation; links can break. |