Skip to content

Commit 484e350

Browse files
committed
Update comments in client version to be doxygen compatible
1 parent 6395ba3 commit 484e350

File tree

1 file changed

+21
-16
lines changed

1 file changed

+21
-16
lines changed

src/clientversion.h

Lines changed: 21 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
// Copyright (c) 2009-2014 The Bitcoin developers
2-
// Distributed under the MIT/X11 software license, see the accompanying
2+
// Distributed under the MIT software license, see the accompanying
33
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
44

55
#ifndef CLIENTVERSION_H
@@ -8,38 +8,43 @@
88
#if defined(HAVE_CONFIG_H)
99
#include "config/bitcoin-config.h"
1010
#else
11-
//
12-
// client versioning and copyright year
13-
//
1411

15-
// These need to be macros, as version.cpp's and bitcoin*-res.rc's voodoo requires it
12+
/**
13+
* client versioning and copyright year
14+
*/
15+
16+
//! These need to be macros, as clientversion.cpp's and bitcoin*-res.rc's voodoo requires it
1617
#define CLIENT_VERSION_MAJOR 0
1718
#define CLIENT_VERSION_MINOR 9
1819
#define CLIENT_VERSION_REVISION 99
1920
#define CLIENT_VERSION_BUILD 0
2021

21-
// Set to true for release, false for prerelease or test build
22+
//! Set to true for release, false for prerelease or test build
2223
#define CLIENT_VERSION_IS_RELEASE false
2324

24-
// Copyright year (2009-this)
25-
// Todo: update this when changing our copyright comments in the source
25+
/**
26+
* Copyright year (2009-this)
27+
* Todo: update this when changing our copyright comments in the source
28+
*/
2629
#define COPYRIGHT_YEAR 2014
2730

2831
#endif //HAVE_CONFIG_H
2932

30-
// Converts the parameter X to a string after macro replacement on X has been performed.
31-
// Don't merge these into one macro!
33+
/**
34+
* Converts the parameter X to a string after macro replacement on X has been performed.
35+
* Don't merge these into one macro!
36+
*/
3237
#define STRINGIZE(X) DO_STRINGIZE(X)
3338
#define DO_STRINGIZE(X) #X
3439

35-
// Copyright string used in Windows .rc files
40+
//! Copyright string used in Windows .rc files
3641
#define COPYRIGHT_STR "2009-" STRINGIZE(COPYRIGHT_YEAR) " The Bitcoin Core Developers"
3742

38-
/*
39-
bitcoind-res.rc includes this file, but it cannot cope with real c++ code.
40-
WINDRES_PREPROC is defined to indicate that its pre-processor is running.
41-
Anything other than a define should be guarded below.
42-
*/
43+
/**
44+
* bitcoind-res.rc includes this file, but it cannot cope with real c++ code.
45+
* WINDRES_PREPROC is defined to indicate that its pre-processor is running.
46+
* Anything other than a define should be guarded below.
47+
*/
4348

4449
#if !defined(WINDRES_PREPROC)
4550

0 commit comments

Comments
 (0)