commit 749a1e990d4f0b54e58ed08d5a09a4e5b2e05994 parent b78b3c2849e01e9f8589bce64ada54d6bda0f2a2 Author: Jacki <jacki@thejackimonster.de> Date: Fri, 26 Jul 2024 17:48:16 +0200 Add more doxygen comments for discourse functions Signed-off-by: Jacki <jacki@thejackimonster.de> Diffstat:
| M | src/discourse.h | | | 14 | ++++++++++++++ |
1 file changed, 14 insertions(+), 0 deletions(-)
diff --git a/src/discourse.h b/src/discourse.h @@ -104,10 +104,24 @@ discourse_destroy_info(struct GNUNET_CHAT_Discourse *discourse); void discourse_update_subscriptions(struct GNUNET_CHAT_Discourse *discourse); +/** + * Pushes a data message of a given discourse to + * update UI elements or output regarding its content. + * + * @param discourse Chat discourse + * @param message Chat message + */ void discourse_stream_message(struct GNUNET_CHAT_Discourse *discourse, const struct GNUNET_CHAT_Message *message); +/** + * Returns whether a given discourse should have controls + * regarding a given type of input/output. + * + * @param discourse Chat discourse + * @return #TRUE if there should be controls, otherwise #FALSE + */ bool discourse_has_controls(struct GNUNET_CHAT_Discourse *discourse, MESSENGER_DiscourseControl control);