Skip to content

Commit

Permalink
#672: docs: convert two missed calls to doxygen
Browse files Browse the repository at this point in the history
  • Loading branch information
lifflander committed Jun 21, 2020
1 parent 20aeac9 commit a932e1d
Showing 1 changed file with 18 additions and 3 deletions.
21 changes: 18 additions & 3 deletions src/vt/termination/termination.h
Original file line number Diff line number Diff line change
Expand Up @@ -551,10 +551,25 @@ struct TerminationDetector :
std::size_t getNumTerminatedCollectiveEpochs() const;

public:
// TermTerminated interface
/**
* \brief Test if an epoch as terminated or not
*
* \param[in] epoch the epoch to test
*
* \return status enum indicating the known state
*/
TermStatusEnum testEpochTerminated(EpochType epoch) override;
// Might return (conservatively) false for some time if the epoch is
// non-local, but will eventually return true

/**
* \brief Check if an epoch has terminated
*
* \note Might return (conservatively) false for some time if the epoch is
* non-local, but will eventually return true
*
* \param[in] epoch the epoch to test
*
* \return whether it is known to be terminated
*/
bool isEpochTerminated(EpochType epoch);

public:
Expand Down

0 comments on commit a932e1d

Please sign in to comment.