ThetaDev/automerge
1
0
Fork 0
Code Issues Pull requests Projects Releases Activity

Switched to C comment delimiting.

Browse source
This commit is contained in:
Jason Kankiewicz 2022-05-06 04:59:47 -05:00
parent bb3d75604a
commit b56464c2e7
1 changed files with 10 additions and 8 deletions

18
automerge-c/examples/quickstart.c
View file

@ -83,14 +83,16 @@ int main(int argc, char** argv) {
AMfreeDoc(doc1);
}
/// \brief Extracts an `AMvalue` struct with discriminant \p value_tag
/// from \p result or writes a message to `stderr`, frees \p result
/// and terminates the program.
///
/// \param[in] result A pointer to an `AMresult` struct.
/// \param[in] value_tag An `AMvalue` struct discriminant.
/// \return An `AMvalue` struct.
/// \pre \p result must be a valid address.
/**
* \brief Extracts an `AMvalue` struct with discriminant \p value_tag
* from \p result or writes a message to `stderr`, frees \p result
* and terminates the program.
*
.* \param[in] result A pointer to an `AMresult` struct.
* \param[in] value_tag An `AMvalue` struct discriminant.
* \return An `AMvalue` struct.
* \pre \p result must be a valid address.
*/
AMvalue test(AMresult* result, AMvalueVariant const value_tag) {
static char prelude[64];