Preliminary documentation of provider interfaces

* Preliminary documentation of CallsCall and CallsMessageSource
* Documentation and cleaning up of CallsCallData
* Add data files and meson rules to create gtk-doc documentation
* Move some macros from util.h to calls-message-source.h
This commit is contained in:
Bob Ham
2018-05-23 09:52:58 +01:00
parent 5abe9cad4e
commit e81567786c
16 changed files with 325 additions and 120 deletions

View File

@@ -40,11 +40,38 @@ struct _CallsMessageSourceInterface
GTypeInterface parent_iface;
};
#define CALLS_ERROR(obj,error) \
CALLS_EMIT_ERROR (CALLS_MESSAGE_SOURCE (obj), error)
/** Array of GTypes for message signals */
GType * calls_message_signal_arg_types();
/**
* CALLS_EMIT_MESSAGE:
* @obj: an object which can be cast to a #CallsMesssageSource
* @text: the message text as a string
* @type: the type of the message
*
* Emit a message signal with the specified information. This is a
* convenience macro for objects implementing interfaces that
* require #CallsMessageSource.
*
*/
#define CALLS_EMIT_MESSAGE(obj,text,type) \
g_signal_emit_by_name (CALLS_MESSAGE_SOURCE(obj), \
"message", text, type)
/**
* CALLS_ERROR:
* @obj: an object which can be cast to a #CallsMesssageSource
* @error: a pointer to a #GError containing the error message
*
* Emit a message signal with an error type, the text of which is
* contained as the message in a #GError. This is a convenience
* macro for objects implementing interfaces that require
* #CallsMessageSource.
*
*/
#define CALLS_ERROR(obj,error) \
CALLS_EMIT_MESSAGE (obj, error->message, GTK_MESSAGE_ERROR)
G_END_DECLS