highperfocused/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-06-30 10:42:23 +02:00
Code Issues Packages Projects Releases Wiki Activity

doc: Use https URLs where possible

Browse Source
This commit is contained in:
Sawyer Billings
2020-12-30 21:49:12 -05:00
committed by fanquake
parent f52f427b8e
commit e8640849c7
14 changed files with 19 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
doc/developer-notes.md
View File

@ -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.