doxygen documentation for checkpoints.{h,cpp}

All functions in src/cryptonote_core/checkpoints.h are now documented in
doxygen style.

checkpoints.cpp has been reviewed, one function has been marked for
discussion on correctness.
This commit is contained in:
Thomas Winget 2015-10-07 22:28:31 -04:00
parent 89c24ac2be
commit 1b0c98e7e9
No known key found for this signature in database
GPG key ID: 58131A160789E630
2 changed files with 99 additions and 6 deletions

View file

@ -84,10 +84,7 @@ namespace cryptonote
return check_block(height, h, ignored);
}
//---------------------------------------------------------------------------
// this basically says if the blockchain is smaller than the first
// checkpoint then alternate blocks are allowed. Alternatively, if the
// last checkpoint *before* the end of the current chain is also before
// the block to be added, then this is fine.
//FIXME: is this the desired behavior?
bool checkpoints::is_alternative_block_allowed(uint64_t blockchain_height, uint64_t block_height) const
{
if (0 == block_height)