8000 Add Doxygen docs generation · etherscan-io/Ravencoin@5c18111 · GitHub
[go: up one dir, main page]
Skip to content

Commit 5c18111

Browse files
hans-schmidtblondfrogs
hans-schmidt
authored and
blondfrogs
committed
Add Doxygen docs generation
1 parent 752c367 commit 5c18111

File tree

8 files changed

+61
-28
lines changed

8 files changed

+61
-28
lines changed

‎Makefile.am

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -292,6 +292,21 @@ CLEANFILES = $(OSX_DMG) $(RAVEN_WIN_INSTALLER)
292292

293293
DISTCHECK_CONFIGURE_FLAGS = --enable-man
294294

295-
clean-local:
295+
doc/doxygen/.stamp: doc/Doxyfile FORCE
296+
$(MKDIR_P) $(@D)
297+
$(DOXYGEN) $^
298+
$(AM_V_at) touch $@
299+
300+
if HAVE_DOXYGEN
301+
docs: doc/doxygen/.stamp
302+
else
303+
docs:
304+
@echo "error: doxygen not found"
305+
endif
306+
307+
clean-docs:
308+
rm -rf doc/doxygen
309+
310+
clean-local: clean-docs
296311
rm -rf coverage_percent.txt test_raven.coverage/ total.coverage/ test/tmp/ cache/ $(OSX_APP)
297312
rm -rf test/functional/__pycache__

‎configure.ac

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,12 @@ AC_PATH_TOOL(READELF, readelf)
9494
AC_PATH_TOOL(CPPFILT, c++filt)
9595
AC_PATH_TOOL(OBJCOPY, objcopy)
9696

97+
AC_PATH_PROG(DOXYGEN, doxygen)
98+
if test -z "$DOXYGEN"; then
99+
AC_MSG_WARN([Doxygen not found])
100+
fi
101+
AM_CONDITIONAL([HAVE_DOXYGEN], [test -n "$DOXYGEN"])
102+
97103
AC_ARG_VAR(PYTHONPATH, Augments the default search path for python module files)
98104

99105
# Enable wallet
@@ -1242,7 +1248,7 @@ AC_SUBST(PROTOBUF_LIBS)
12421248
AC_SUBST(QR_LIBS)
12431249
AC_CONFIG_FILES([Makefile src/Makefile doc/man/Makefile share/setup.nsi share/qt/Info.plist test/config.ini])
12441250
AC_CONFIG_FILES([contrib/devtools/split-debug.sh],[chmod +x contrib/devtools/split-debug.sh])
1245-
AC_CONFIG_FILES([doc/Doxyfile])
1251+
AM_COND_IF([HAVE_DOXYGEN], [AC_CONFIG_FILES([doc/Doxyfile])])
12461252
AC_CONFIG_LINKS([contrib/filter-lcov.py:contrib/filter-lcov.py])
12471253
AC_CONFIG_LINKS([test/functional/test_runner.py:test/functional/test_runner.py])
12481254
AC_CONFIG_LINKS([test/util/raven-util-test.py:test/util/raven-util-test.py])

‎doc/developer-notes.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,9 +129,21 @@ Not OK (used plenty in the current source, but not picked up):
129129
//
130130
```
131131

132-
A full list of comment syntaxes picked up by doxygen can be found at http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html,
132+
A full list of comment syntaxes picked up by doxygen can be found at
133+
http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html,
133134
but if possible use one of the above styles.
134135

136+
The Ravencoin Doxygen documentation can be generated by running `make docs` from the top-level
137+
directory of the repository.
138+
That creates the documentation in the directory "doc/doxygen" and the it can be accessed by a browser at:
139+
doc/doxygen/html/index.html
140+
The documentation can by deleted by running `make clean-docs`.
141+
142+
Before running `make docs`, you will need to install dependencies `doxygen` and `dot` (a component
143+
of `graphviz`). For example,
144+
on MacOS via Homebrew: `brew install doxygen --with-graphviz`
145+
on Debian/Ubuntu: `sudo install doxygen graphviz`
146+
135147
Development tips and tricks
136148
---------------------------
137149

‎src/net_processing.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ class PeerLogicValidation final: public CValidationInterface, public NetEventsIn
6767
void EvictExtraOutboundPeers(int64_t time_in_seconds);
6868

6969
private:
70-
int64_t m_stale_tip_check_time; //! Next time to check for stale tip
70+
int64_t m_stale_tip_check_time; //!< Next time to check for stale tip
7171
};
7272

7373
struct CNodeStateStats {

‎src/netbase.cpp

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -193,10 +193,10 @@ enum SOCKSVersion: uint8_t {
193193

194194
/** Values defined for METHOD in RFC1928 */
195195
enum SOCKS5Method: uint8_t {
196-
NOAUTH = 0x00, //! No authentication required
197-
GSSAPI = 0x01, //! GSSAPI
198-
USER_PASS = 0x02, //! Username/password
199-
NO_ACCEPTABLE = 0xff, //! No acceptable methods
196+
NOAUTH = 0x00, //!< No authentication required
197+
GSSAPI = 0x01, //!< GSSAPI
198+
USER_PASS = 0x02, //!< Username/password
199+
NO_ACCEPTABLE = 0xff, //!< No acceptable methods
200200
};
201201

202202
/** Values defined for CMD in RFC1928 */
@@ -208,15 +208,15 @@ enum SOCKS5Command: uint8_t {
208208

209209
/** Values defined for REP in RFC1928 */
210210
enum SOCKS5Reply: uint8_t {
211-
SUCCEEDED = 0x00, //! Succeeded
212-
GENFAILURE = 0x01, //! General failure
213-
NOTALLOWED = 0x02, //! Connection not allowed by ruleset
214-
NETUNREACHABLE = 0x03, //! Network unreachable
215-
HOSTUNREACHABLE = 0x04, //! Network unreachable
216-
CONNREFUSED = 0x05, //! Connection refused
217-
TTLEXPIRED = 0x06, //! TTL expired
218-
CMDUNSUPPORTED = 0x07, //! Command not supported
219-
ATYPEUNSUPPORTED = 0x08, //! Address type not supported
211+
SUCCEEDED = 0x00, //!< Succeeded
212+
GENFAILURE = 0x01, //!< General failure
213+
NOTALLOWED = 0x02, //!< Connection not allowed by ruleset
214+
NETUNREACHABLE = 0x03, //!< Network unreachable
215+
HOSTUNREACHABLE = 0x04, //!< Network unreachable
216+
CONNREFUSED = 0x05, //!< Connection refused
217+
TTLEXPIRED = 0x06, //!< TTL expired
218+
CMDUNSUPPORTED = 0x07, //!< Command not supported
219+
ATYPEUNSUPPORTED = 0x08, //!< Address type not supported
220220
};
221221

222222
/** Values defined for ATYPE in RFC1928 */

‎src/policy/fees.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,9 +96,9 @@ std::string StringForFeeReason(FeeReason reason);
9696

9797
/* Used to determine type of fee estimation requested */
9898
enum class FeeEstimateMode {
99-
UNSET, //! Use default settings based on other criteria
100-
ECONOMICAL, //! Force estimateSmartFee to use non-conservative estimates
101-
CONSERVATIVE, //! Force estimateSmartFee to use conservative estimates
99+
UNSET, //!< Use default settings based on other criteria
100+
ECONOMICAL, //!< Force estimateSmartFee to use non-conservative estimates
101+
CONSERVATIVE, //!< Force estimateSmartFee to use conservative estimates
102102
};
103103

104104
bool FeeModeFromString(const std::string& mode_string, FeeEstimateMode& fee_estimate_mode);

‎src/primitives/transaction.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ class CTxIn
7070
COutPoint prevout;
7171
CScript scriptSig;
7272
uint32_t nSequence;
73-
CScriptWitness scriptWitness; //! Only serialized through CTransaction
73+
CScriptWitness scriptWitness; //!< Only serialized through CTransaction
7474

7575
/* Setting nSequence to this value for every input in a transaction
7676
* disables nLockTime. */

‎src/txmempool.h

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -318,13 +318,13 @@ struct TxMempoolInfo
318318
* this is passed to the notification signal.
319319
*/
320320
enum class MemPoolRemovalReason {
321-
UNKNOWN = 0, //! Manually removed or unknown reason
322-
EXPIRY, //! Expired from mempool
323-
SIZELIMIT, //! Removed in size limiting
324-
REORG, //! Removed for reorganization
325-
BLOCK, //! Removed for block
326-
CONFLICT, //! Removed for conflict with in-block transaction
327-
REPLACED //! Removed for replacement
321+
UNKNOWN = 0, //!< Manually removed or unknown reason
322+
EXPIRY, //!< Expired from mempool
323+
SIZELIMIT, //!< Removed in size limiting
324+
REORG, //!< Removed for reorganization
325+
BLOCK, //!< Removed for block
326+
CONFLICT, //!< Removed for conflict with in-block transaction
327+
REPLACED, //!< Removed for replacement
328328
};
329329

330330
class SaltedTxidHasher

0 commit comments

Comments
 (0)
0