This repository was archived by the owner on Mar 22, 2023. It is now read-only.
File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -443,16 +443,22 @@ class transaction_base {
443443 }
444444 }
445445
446- /* *
447- * Possible stages of a transaction, for every stage one or more
448- * callbacks can be registered.
446+ /* ! \enum stage
447+ \brief Possible stages of a transaction.
448+
449+ For every stage one or more callbacks can be registered
450+ (see transaction::register_callback()).
451+
452+ To read more about PMDK's transactions and their stages, see
453+ manpage pmemobj_tx_begin(3):
454+ https://pmem.io/pmdk/manpages/linux/master/libpmemobj/pmemobj_tx_begin.3
449455 */
450456 enum class stage {
451- work = TX_STAGE_WORK, /* transaction in progress */
452- oncommit = TX_STAGE_ONCOMMIT, /* successfully committed */
453- onabort = TX_STAGE_ONABORT, /* tx_begin failed or transaction
454- aborted */
455- finally = TX_STAGE_FINALLY, /* ready for cleanup */
457+ work = TX_STAGE_WORK, /* *< transaction in progress */
458+ oncommit = TX_STAGE_ONCOMMIT, /* *< successfully committed */
459+ onabort = TX_STAGE_ONABORT, /* *< tx_begin failed or transaction
460+ aborted */
461+ finally = TX_STAGE_FINALLY, /* *< ready for cleanup */
456462 };
457463
458464 /* *
You can’t perform that action at this time.
0 commit comments