Add since tags

This commit is contained in:
Matthias Clasen 2011-12-10 20:47:22 -05:00
parent 829b4dfb43
commit f109415d95
6 changed files with 150 additions and 49 deletions

View File

@ -454,7 +454,9 @@ g_dbus_action_group_iface_init (GActionGroupInterface *iface)
* g_action_group_list_actions() to get the initial list.
*
* Returns: (transfer full): a #GDBusActionGroup
**/
*
* Since: 2.32
*/
GDBusActionGroup *
g_dbus_action_group_get (GDBusConnection *connection,
const gchar *bus_name,

View File

@ -860,7 +860,10 @@ g_dbus_menu_model_get_from_group (GDBusMenuGroup *group,
* (and linked models) must also originate from this same context, with
* the thread default main context unchanged.
*
* Returns: (transfer full): a #GDBusMenuModel object. Free with g_object_unref().
* Returns: (transfer full): a #GDBusMenuModel object. Free with
* g_object_unref().
*
* Since: 2.32
*/
GDBusMenuModel *
g_dbus_menu_model_get (GDBusConnection *connection,

View File

@ -146,7 +146,9 @@ g_menu_get_item_links (GMenuModel *model,
* See g_menu_insert(), g_menu_insert_section() and
* g_menu_insert_submenu() as well as "prepend" and "append" variants of
* each of these functions.
**/
*
* Since: 2.32
*/
void
g_menu_insert_item (GMenu *menu,
gint position,
@ -176,7 +178,9 @@ g_menu_insert_item (GMenu *menu,
* Prepends @item to the start of @menu.
*
* See g_menu_insert_item() for more information.
**/
*
* Since: 2.32
*/
void
g_menu_prepend_item (GMenu *menu,
GMenuItem *item)
@ -192,7 +196,9 @@ g_menu_prepend_item (GMenu *menu,
* Appends @item to the end of @menu.
*
* See g_menu_insert_item() for more information.
**/
*
* Since: 2.32
*/
void
g_menu_append_item (GMenu *menu,
GMenuItem *item)
@ -212,7 +218,9 @@ g_menu_append_item (GMenu *menu,
*
* This function causes g_menu_model_is_mutable() to begin returning
* %FALSE, which has some positive performance implications.
**/
*
* Since: 2.32
*/
void
g_menu_freeze (GMenu *menu)
{
@ -229,7 +237,9 @@ g_menu_freeze (GMenu *menu)
* The new menu has no items.
*
* Returns: a new #GMenu
**/
*
* Since: 2.32
*/
GMenu *
g_menu_new (void)
{
@ -246,7 +256,9 @@ g_menu_new (void)
* Convenience function for inserting a normal menu item into @menu.
* Combine g_menu_new() and g_menu_insert_item() for a more flexible
* alternative.
**/
*
* Since: 2.32
*/
void
g_menu_insert (GMenu *menu,
gint position,
@ -269,7 +281,9 @@ g_menu_insert (GMenu *menu,
* Convenience function for prepending a normal menu item to the start
* of @menu. Combine g_menu_new() and g_menu_insert_item() for a more
* flexible alternative.
**/
*
* Since: 2.32
*/
void
g_menu_prepend (GMenu *menu,
const gchar *label,
@ -287,7 +301,9 @@ g_menu_prepend (GMenu *menu,
* Convenience function for appending a normal menu item to the end of
* @menu. Combine g_menu_new() and g_menu_insert_item() for a more
* flexible alternative.
**/
*
* Since: 2.32
*/
void
g_menu_append (GMenu *menu,
const gchar *label,
@ -306,7 +322,9 @@ g_menu_append (GMenu *menu,
* Convenience function for inserting a section menu item into @menu.
* Combine g_menu_new_section() and g_menu_insert_item() for a more
* flexible alternative.
**/
*
* Since: 2.32
*/
void
g_menu_insert_section (GMenu *menu,
gint position,
@ -330,7 +348,9 @@ g_menu_insert_section (GMenu *menu,
* Convenience function for prepending a section menu item to the start
* of @menu. Combine g_menu_new_section() and g_menu_insert_item() for
* a more flexible alternative.
**/
*
* Since: 2.32
*/
void
g_menu_prepend_section (GMenu *menu,
const gchar *label,
@ -348,7 +368,9 @@ g_menu_prepend_section (GMenu *menu,
* Convenience function for appending a section menu item to the end of
* @menu. Combine g_menu_new_section() and g_menu_insert_item() for a
* more flexible alternative.
**/
*
* Since: 2.32
*/
void
g_menu_append_section (GMenu *menu,
const gchar *label,
@ -367,7 +389,9 @@ g_menu_append_section (GMenu *menu,
* Convenience function for inserting a submenu menu item into @menu.
* Combine g_menu_new_submenu() and g_menu_insert_item() for a more
* flexible alternative.
**/
*
* Since: 2.32
*/
void
g_menu_insert_submenu (GMenu *menu,
gint position,
@ -390,7 +414,9 @@ g_menu_insert_submenu (GMenu *menu,
* Convenience function for prepending a submenu menu item to the start
* of @menu. Combine g_menu_new_submenu() and g_menu_insert_item() for
* a more flexible alternative.
**/
*
* Since: 2.32
*/
void
g_menu_prepend_submenu (GMenu *menu,
const gchar *label,
@ -408,7 +434,9 @@ g_menu_prepend_submenu (GMenu *menu,
* Convenience function for appending a submenu menu item to the end of
* @menu. Combine g_menu_new_submenu() and g_menu_insert_item() for a
* more flexible alternative.
**/
*
* Since: 2.32
*/
void
g_menu_append_submenu (GMenu *menu,
const gchar *label,
@ -441,7 +469,9 @@ g_menu_clear_item (struct item *item)
* It is not possible to remove items by identity since items are added
* to the menu simply by copying their links and attributes (ie:
* identity of the item itself is not preserved).
**/
*
* Since: 2.32
*/
void
g_menu_remove (GMenu *menu,
gint position)
@ -608,7 +638,9 @@ valid_attribute_name (const gchar *name)
*
* See also g_menu_item_set_attribute() for a more convenient way to do
* the same.
**/
*
* Since: 2.32
*/
void
g_menu_item_set_attribute_value (GMenuItem *menu_item,
const gchar *attribute,
@ -650,7 +682,9 @@ g_menu_item_set_attribute_value (GMenuItem *menu_item,
*
* See also g_menu_item_set_attribute_value() for an equivalent call
* that directly accepts a #GVariant.
**/
*
* Since: 2.32
*/
void
g_menu_item_set_attribute (GMenuItem *menu_item,
const gchar *attribute,
@ -689,6 +723,8 @@ g_menu_item_set_attribute (GMenuItem *menu_item,
* Link types are restricted to lowercase characters, numbers
* and '-'. Furthermore, the names must begin with a lowercase character,
* must not end with a '-', and must not contain consecutive dashes.
*
* Since: 2.32
*/
void
g_menu_item_set_link (GMenuItem *menu_item,
@ -716,7 +752,9 @@ g_menu_item_set_link (GMenuItem *menu_item,
*
* If @label is non-%NULL it is used as the label for the menu item. If
* it is %NULL then the label attribute is unset.
**/
*
* Since: 2.32
*/
void
g_menu_item_set_label (GMenuItem *menu_item,
const gchar *label)
@ -743,7 +781,9 @@ g_menu_item_set_label (GMenuItem *menu_item,
*
* The effect of having one menu appear as a submenu of another is
* exactly as it sounds.
**/
*
* Since: 2.32
*/
void
g_menu_item_set_submenu (GMenuItem *menu_item,
GMenuModel *submenu)
@ -763,7 +803,9 @@ g_menu_item_set_submenu (GMenuItem *menu_item,
* the menu that @menu_item is added to. See g_menu_item_new_section()
* for more information about what it means for a menu item to be a
* section.
**/
*
* Since: 2.32
*/
void
g_menu_item_set_section (GMenuItem *menu_item,
GMenuModel *section)
@ -813,6 +855,8 @@ g_menu_item_set_section (GMenuItem *menu_item,
* See g_menu_item_set_action_and_target() or
* g_menu_item_set_detailed_action() for two equivalent calls that are
* probably more convenient for most uses.
*
* Since: 2.32
*/
void
g_menu_item_set_action_and_target_value (GMenuItem *menu_item,
@ -861,6 +905,8 @@ g_menu_item_set_action_and_target_value (GMenuItem *menu_item,
*
* See also g_menu_item_set_action_and_target_value() for a
* description of the semantics of the action and target attributes.
*
* Since: 2.32
*/
void
g_menu_item_set_action_and_target (GMenuItem *menu_item,
@ -907,7 +953,9 @@ g_menu_item_set_action_and_target (GMenuItem *menu_item,
*
* See also g_menu_set_action_and_target_value() for a description of
* the semantics of the action and target attributes.
**/
*
* Since: 2.32
*/
void
g_menu_item_set_detailed_action (GMenuItem *menu_item,
const gchar *detailed_action)
@ -944,7 +992,9 @@ g_menu_item_set_detailed_action (GMenuItem *menu_item,
* g_menu_item_set_detailed_action() for more information.
*
* Returns: a new #GMenuItem
**/
*
* Since: 2.32
*/
GMenuItem *
g_menu_item_new (const gchar *label,
const gchar *detailed_action)
@ -973,7 +1023,9 @@ g_menu_item_new (const gchar *label,
* g_menu_item_set_submenu().
*
* Returns: a new #GMenuItem
**/
*
* Since: 2.32
*/
GMenuItem *
g_menu_item_new_submenu (const gchar *label,
GMenuModel *submenu)
@ -1059,7 +1111,9 @@ g_menu_item_new_submenu (const gchar *label,
* ]]></programlisting></informalexample>
*
* Returns: a new #GMenuItem
**/
*
* Since: 2.32
*/
GMenuItem *
g_menu_item_new_section (const gchar *label,
GMenuModel *section)

View File

@ -837,6 +837,8 @@ g_menu_exporter_method_call (GDBusConnection *connection,
* this function.
*
* Returns: the ID of the export (never zero), or 0 in case of failure
*
* Since: 2.32
*/
guint
g_dbus_connection_export_menu_model (GDBusConnection *connection,
@ -883,7 +885,7 @@ g_dbus_connection_export_menu_model (GDBusConnection *connection,
* same ID more than once.
*
* Since: 2.32
**/
*/
void
g_dbus_connection_unexport_menu_model (GDBusConnection *connection,
guint export_id)

View File

@ -440,6 +440,8 @@ static GMarkupParser g_menu_subparser =
* the element representing the group containing the menus. In other
* words, the content inside of this element is expected to be a list of
* menus.
*
* Since: 2.32
*/
void
g_menu_markup_parser_start (GMarkupParseContext *context,
@ -476,7 +478,9 @@ g_menu_markup_parser_start (GMarkupParseContext *context,
* See that function for more information
*
* Returns: (transfer full): the #GHashTable containing the objects
**/
*
* Since: 2.32
*/
GHashTable *
g_menu_markup_parser_end (GMarkupParseContext *context)
{
@ -517,7 +521,9 @@ g_menu_markup_parser_end (GMarkupParseContext *context)
* You should call g_menu_markup_parser_end_menu() from the
* corresponding end_element function in order to collect the newly
* parsed menu.
**/
*
* Since: 2.32
*/
void
g_menu_markup_parser_start_menu (GMarkupParseContext *context,
const gchar *domain,
@ -549,7 +555,9 @@ g_menu_markup_parser_start_menu (GMarkupParseContext *context,
* See that function for more information
*
* Returns: (transfer full): the newly-created #GMenu
**/
*
* Since: 2.32
*/
GMenu *
g_menu_markup_parser_end_menu (GMarkupParseContext *context)
{
@ -703,7 +711,7 @@ g_menu_markup_print_string (GString *string,
* Print @model to stderr for debugging purposes.
*
* This debugging function will be removed in the future.
**/
*/
void
g_menu_markup_print_stderr (GMenuModel *model)
{

View File

@ -460,8 +460,10 @@ g_menu_model_class_init (GMenuModelClass *class)
* signal. Consumers of the model may make optimisations accordingly.
*
* Returns: %TRUE if the model is mutable (ie: "items-changed" may be
* emitted).
**/
* emitted).
*
* Since: 2.32
*/
gboolean
g_menu_model_is_mutable (GMenuModel *model)
{
@ -476,7 +478,9 @@ g_menu_model_is_mutable (GMenuModel *model)
* Query the number of items in @model.
*
* Returns: the number of items
**/
*
* Since: 2.32
*/
gint
g_menu_model_get_n_items (GMenuModel *model)
{
@ -495,6 +499,8 @@ g_menu_model_get_n_items (GMenuModel *model)
* You must free the iterator with g_object_unref() when you are done.
*
* Returns: (transfer full): a new #GMenuAttributeIter
*
* Since: 2.32
*/
GMenuAttributeIter *
g_menu_model_iterate_item_attributes (GMenuModel *model,
@ -525,7 +531,9 @@ g_menu_model_iterate_item_attributes (GMenuModel *model,
* then %NULL is returned.
*
* Returns: (transfer full): the value of the attribute
**/
*
* Since: 2.32
*/
GVariant *
g_menu_model_get_item_attribute_value (GMenuModel *model,
gint item_index,
@ -556,8 +564,10 @@ g_menu_model_get_item_attribute_value (GMenuModel *model,
* returned.
*
* Returns: %TRUE if the named attribute was found with the expected
* type
**/
* type
*
* Since: 2.32
*/
gboolean
g_menu_model_get_item_attribute (GMenuModel *model,
gint item_index,
@ -594,7 +604,9 @@ g_menu_model_get_item_attribute (GMenuModel *model,
* You must free the iterator with g_object_unref() when you are done.
*
* Returns: (transfer full): a new #GMenuLinkIter
**/
*
* Since: 2.32
*/
GMenuLinkIter *
g_menu_model_iterate_item_links (GMenuModel *model,
gint item_index)
@ -616,7 +628,9 @@ g_menu_model_iterate_item_links (GMenuModel *model,
* does not exist, %NULL is returned.
*
* Returns: (transfer full): the linked #GMenuModel, or %NULL
**/
*
* Since: 2.32
*/
GMenuModel *
g_menu_model_get_item_link (GMenuModel *model,
gint item_index,
@ -648,7 +662,9 @@ g_menu_model_get_item_link (GMenuModel *model,
* entry and not in response to calls -- particularly those from the
* #GMenuModel API. Said another way: the menu must not change while
* user code is running without returning to the mainloop.
**/
*
* Since: 2.32
*/
void
g_menu_model_items_changed (GMenuModel *model,
gint position,
@ -690,8 +706,10 @@ struct _GMenuAttributeIterPrivate
* be unreffed using g_variant_unref() when it is no longer in use.
*
* Returns: %TRUE on success, or %FALSE if there is no additional
* attribute
**/
* attribute
*
* Since: 2.32
*/
gboolean
g_menu_attribute_iter_get_next (GMenuAttributeIter *iter,
const gchar **out_name,
@ -736,7 +754,9 @@ g_menu_attribute_iter_get_next (GMenuAttributeIter *iter,
* attribute exists at all).
*
* Returns: %TRUE on success, or %FALSE when there are no more attributes
**/
*
* Since: 2.32
*/
gboolean
g_menu_attribute_iter_next (GMenuAttributeIter *iter)
{
@ -753,7 +773,9 @@ g_menu_attribute_iter_next (GMenuAttributeIter *iter)
* The iterator is not advanced.
*
* Returns: the name of the attribute
**/
*
* Since: 2.32
*/
const gchar *
g_menu_attribute_iter_get_name (GMenuAttributeIter *iter)
{
@ -771,7 +793,9 @@ g_menu_attribute_iter_get_name (GMenuAttributeIter *iter)
* The iterator is not advanced.
*
* Returns: (transfer full): the value of the current attribute
**/
*
* Since: 2.32
*/
GVariant *
g_menu_attribute_iter_get_value (GMenuAttributeIter *iter)
{
@ -839,7 +863,9 @@ struct _GMenuLinkIterPrivate
* be unreffed using g_object_unref() when it is no longer in use.
*
* Returns: %TRUE on success, or %FALSE if there is no additional link
**/
*
* Since: 2.32
*/
gboolean
g_menu_link_iter_get_next (GMenuLinkIter *iter,
const gchar **out_link,
@ -885,7 +911,9 @@ g_menu_link_iter_get_next (GMenuLinkIter *iter,
* at all).
*
* Returns: %TRUE on success, or %FALSE when there are no more links
**/
*
* Since: 2.32
*/
gboolean
g_menu_link_iter_next (GMenuLinkIter *iter)
{
@ -901,7 +929,9 @@ g_menu_link_iter_next (GMenuLinkIter *iter)
* The iterator is not advanced.
*
* Returns: the type of the link
**/
*
* Since: 2.32
*/
const gchar *
g_menu_link_iter_get_name (GMenuLinkIter *iter)
{
@ -919,7 +949,9 @@ g_menu_link_iter_get_name (GMenuLinkIter *iter)
* The iterator is not advanced.
*
* Returns: (transfer full): the #GMenuModel that is linked to
**/
*
* Since: 2.32
*/
GMenuModel *
g_menu_link_iter_get_value (GMenuLinkIter *iter)
{