[folks/648811-dummy-backend-rebase1: 44/48] dummy: Documentation link fixes

From: Philip Withnall <pwithnall src gnome org>
To: commits-list gnome org
Cc:
Subject: [folks/648811-dummy-backend-rebase1: 44/48] dummy: Documentation link fixes
Date: Thu, 7 Nov 2013 10:26:19 +0000 (UTC)
commit 14659ba0937fd5c1f27bf3f5a1a1ae7fa9c933be
Author: Philip Withnall <philip withnall collabora co uk>
Date:   Thu Nov 7 10:04:50 2013 +0000

    dummy: Documentation link fixes

 backends/dummy/lib/dummy-backend.vala       |   33 +++---
 backends/dummy/lib/dummy-fat-persona.vala   |   90 ++++++++--------
 backends/dummy/lib/dummy-persona-store.vala |  155 ++++++++++++++-------------
 backends/dummy/lib/dummy-persona.vala       |   26 +++--
 4 files changed, 157 insertions(+), 147 deletions(-)
---
diff --git a/backends/dummy/lib/dummy-backend.vala b/backends/dummy/lib/dummy-backend.vala
index 16e2f26..fbd89b3 100644
--- a/backends/dummy/lib/dummy-backend.vala
+++ b/backends/dummy/lib/dummy-backend.vala
@@ -39,10 +39,11 @@ extern const string BACKEND_NAME;
  * former). { link FolksDummy.Backend.register_persona_stores} adds persona
  * stores to the set of all stores. Optionally it also enables them, adding them
  * to the set of enabled stores. The set of persona stores advertised by the
- * backend as { link Backend.persona_stores} is the set of enabled stores.
+ * backend as { link Folks.Backend.persona_stores} is the set of enabled stores.
  * libfolks may internally enable or disable stores using
- * { link Backend.enable_persona_store}, { link Backend.disable_persona_store}
- * and { link Backend.set_persona_stores}.
+ * { link Folks.Backend.enable_persona_store},
+ * { link Folks.Backend.disable_persona_store}
+ * and { link Folks.Backend.set_persona_stores}.
  *
  * The API in { link FolksDummy} is unstable and may change wildly. It is
  * designed mostly for use by libfolks unit tests.
@@ -310,15 +311,15 @@ public class FolksDummy.Backend : Folks.Backend
    *
    * For each of the persona stores in ``stores``, register it with this
    * backend. If ``enable_stores`` is ``true``, added stores will also be
-   * enabled, emitting { link Backend.persona_store_added} for each
+   * enabled, emitting { link Folks.Backend.persona_store_added} for each
    * newly-enabled store. After all addition signals are emitted, a change
-   * notification for { link Backend.persona_stores} will be emitted (but only
-   * if at least one addition signal is emitted).
+   * notification for { link Folks.Backend.persona_stores} will be emitted (but
+   * only if at least one addition signal is emitted).
    *
-   * Persona stores are identified by their { link PersonaStore.id}; if a store
-   * in ``stores`` has the same ID as a store previously registered through this
-   * method, the duplicate will be ignored (so
-   * { link Backend.persona_store_added} won't be emitted for that store).
+   * Persona stores are identified by their { link Folks.PersonaStore.id}; if a
+   * store in ``stores`` has the same ID as a store previously registered
+   * through this method, the duplicate will be ignored (so
+   * { link Folks.Backend.persona_store_added} won't be emitted for that store).
    *
    * Persona stores must be instances of { link FolksDummy.PersonaStore} or
    * subclasses of it, allowing for different persona store implementations to
@@ -352,18 +353,18 @@ public class FolksDummy.Backend : Folks.Backend
     }
 
   /**
-   * Disable and unregister some { link FolksDummy.PersonaStores}.
+   * Disable and unregister some { link FolksDummy.PersonaStore}s.
    *
    * For each of the persona stores in ``stores``, disable it (if it was
    * enabled) and unregister it from the backend so that it cannot be re-enabled
-   * using { link Backend.enable_persona_store} or
-   * { link Backend.set_persona_stores}.
+   * using { link Folks.Backend.enable_persona_store} or
+   * { link Folks.Backend.set_persona_stores}.
    *
-   * { link Backend.persona_store_removed} will be emitted for all persona
+   * { link Folks.Backend.persona_store_removed} will be emitted for all persona
    * stores in ``stores`` which were previously enabled. After all removal
    * signals are emitted, a change notification for
-   * { link Backend.persona_stores} will be emitted (but only if at least one
-   * removal signal is emitted).
+   * { link Folks.Backend.persona_stores} will be emitted (but only if at least
+   * one removal signal is emitted).
    *
    * @since UNRELEASED
    */
diff --git a/backends/dummy/lib/dummy-fat-persona.vala b/backends/dummy/lib/dummy-fat-persona.vala
index 013c2bf..37c7d7a 100644
--- a/backends/dummy/lib/dummy-fat-persona.vala
+++ b/backends/dummy/lib/dummy-fat-persona.vala
@@ -38,7 +38,8 @@ using GLib;
  * option.
  *
  * There are two sides to this class’ interface: the normal methods required by
- * the libfolks ‘details’ interfaces, such as { link FatPersona.change_gender},
+ * the libfolks ‘details’ interfaces, such as
+ * { link Folks.GenderDetails.change_gender},
  * and the backend methods which should be called by test driver code to
  * simulate changes in the backing store providing this persona, such as
  * { link FatPersona.update_gender}. For example, test driver code should call
@@ -71,8 +72,8 @@ public class FolksDummy.FatPersona : FolksDummy.Persona,
   /**
    * Create a new ‘fat’ persona.
    *
-   * Create a new persona for the { link PersonaStore} ``store``, with the given
-   * construct-only properties.
+   * Create a new persona for the { link FolksDummy.PersonaStore} ``store``,
+   * with the given construct-only properties.
    *
    * @param store the store which will contain the persona
    * @param contact_id a unique free-form string identifier for the persona
@@ -725,7 +726,7 @@ public class FolksDummy.FatPersona : FolksDummy.Persona,
    * Update persona's gender.
    *
    * This simulates a backing-store-side update of the persona's
-   * { link GenderDetails.gender} property. It is intended to be used for
+   * { link Folks.GenderDetails.gender} property. It is intended to be used for
    * testing code which consumes this property. If the property value changes,
    * this results in a property change notification on the persona.
    *
@@ -745,9 +746,10 @@ public class FolksDummy.FatPersona : FolksDummy.Persona,
    * Update persona's birthday calendar event ID.
    *
    * This simulates a backing-store-side update of the persona's
-   * { link BirthdayDetails.calendar_event_id} property. It is intended to be
-   * used for testing code which consumes this property. If the property value
-   * changes, this results in a property change notification on the persona.
+   * { link Folks.BirthdayDetails.calendar_event_id} property. It is intended to
+   * be used for testing code which consumes this property. If the property
+   * value changes, this results in a property change notification on the
+   * persona.
    *
    * @param calendar_event_id persona's new birthday calendar event ID
    * @since UNRELEASED
@@ -765,9 +767,9 @@ public class FolksDummy.FatPersona : FolksDummy.Persona,
    * Update persona's birthday.
    *
    * This simulates a backing-store-side update of the persona's
-   * { link BirthdayDetails.birthday} property. It is intended to be used for
-   * testing code which consumes this property. If the property value changes,
-   * this results in a property change notification on the persona.
+   * { link Folks.BirthdayDetails.birthday} property. It is intended to be used
+   * for testing code which consumes this property. If the property value
+   * changes, this results in a property change notification on the persona.
    *
    * @param birthday persona's new birthday
    * @since UNRELEASED
@@ -787,7 +789,7 @@ public class FolksDummy.FatPersona : FolksDummy.Persona,
    * Update persona's roles.
    *
    * This simulates a backing-store-side update of the persona's
-   * { link RoleDetails.roles} property. It is intended to be used for
+   * { link Folks.RoleDetails.roles} property. It is intended to be used for
    * testing code which consumes this property. If the property value changes,
    * this results in a property change notification on the persona.
    *
@@ -808,7 +810,7 @@ public class FolksDummy.FatPersona : FolksDummy.Persona,
    * Update persona's groups.
    *
    * This simulates a backing-store-side update of the persona's
-   * { link GroupDetails.groups} property. It is intended to be used for
+   * { link Folks.GroupDetails.groups} property. It is intended to be used for
    * testing code which consumes this property. If the property value changes,
    * this results in a property change notification on the persona.
    *
@@ -829,10 +831,10 @@ public class FolksDummy.FatPersona : FolksDummy.Persona,
    * Update persona's web service addresses.
    *
    * This simulates a backing-store-side update of the persona's
-   * { link WebServiceDetails.web_service_addresses} property. It is intended to
-   * be used for testing code which consumes this property. If the property
-   * value changes, this results in a property change notification on the
-   * persona.
+   * { link Folks.WebServiceDetails.web_service_addresses} property. It is
+   * intended to be used for testing code which consumes this property. If the
+   * property value changes, this results in a property change notification on
+   * the persona.
    *
    * @param web_service_addresses persona's new web service addresses
    * @since UNRELEASED
@@ -854,8 +856,8 @@ public class FolksDummy.FatPersona : FolksDummy.Persona,
    * Update persona's e-mail addresses.
    *
    * This simulates a backing-store-side update of the persona's
-   * { link EmailDetails.email_addresses} property. It is intended to be used
-   * for testing code which consumes this property. If the property value
+   * { link Folks.EmailDetails.email_addresses} property. It is intended to be
+   * used for testing code which consumes this property. If the property value
    * changes, this results in a property change notification on the persona.
    *
    * @param email_addresses persona's new e-mail addresses
@@ -877,7 +879,7 @@ public class FolksDummy.FatPersona : FolksDummy.Persona,
    * Update persona's notes.
    *
    * This simulates a backing-store-side update of the persona's
-   * { link NoteDetails.notes} property. It is intended to be used for
+   * { link Folks.NoteDetails.notes} property. It is intended to be used for
    * testing code which consumes this property. If the property value changes,
    * this results in a property change notification on the persona.
    *
@@ -898,7 +900,7 @@ public class FolksDummy.FatPersona : FolksDummy.Persona,
    * Update persona's full name.
    *
    * This simulates a backing-store-side update of the persona's
-   * { link NameDetails.full_name} property. It is intended to be used for
+   * { link Folks.NameDetails.full_name} property. It is intended to be used for
    * testing code which consumes this property. If the property value changes,
    * this results in a property change notification on the persona.
    *
@@ -918,7 +920,7 @@ public class FolksDummy.FatPersona : FolksDummy.Persona,
    * Update persona's nickname.
    *
    * This simulates a backing-store-side update of the persona's
-   * { link NameDetails.nickname} property. It is intended to be used for
+   * { link Folks.NameDetails.nickname} property. It is intended to be used for
    * testing code which consumes this property. If the property value changes,
    * this results in a property change notification on the persona.
    *
@@ -938,9 +940,9 @@ public class FolksDummy.FatPersona : FolksDummy.Persona,
    * Update persona's structured name.
    *
    * This simulates a backing-store-side update of the persona's
-   * { link NameDetails.structured_name} property. It is intended to be used for
-   * testing code which consumes this property. If the property value changes,
-   * this results in a property change notification on the persona.
+   * { link Folks.NameDetails.structured_name} property. It is intended to be
+   * used for testing code which consumes this property. If the property value
+   * changes, this results in a property change notification on the persona.
    *
    * @param structured_name persona's new structured name
    * @since UNRELEASED
@@ -963,7 +965,7 @@ public class FolksDummy.FatPersona : FolksDummy.Persona,
    * Update persona's avatar.
    *
    * This simulates a backing-store-side update of the persona's
-   * { link AvatarDetails.avatar} property. It is intended to be used for
+   * { link Folks.AvatarDetails.avatar} property. It is intended to be used for
    * testing code which consumes this property. If the property value changes,
    * this results in a property change notification on the persona.
    *
@@ -985,7 +987,7 @@ public class FolksDummy.FatPersona : FolksDummy.Persona,
    * Update persona's URIs.
    *
    * This simulates a backing-store-side update of the persona's
-   * { link UrlDetails.urls} property. It is intended to be used for
+   * { link Folks.UrlDetails.urls} property. It is intended to be used for
    * testing code which consumes this property. If the property value changes,
    * this results in a property change notification on the persona.
    *
@@ -1006,9 +1008,9 @@ public class FolksDummy.FatPersona : FolksDummy.Persona,
    * Update persona's IM addresses.
    *
    * This simulates a backing-store-side update of the persona's
-   * { link ImDetails.im_addresses} property. It is intended to be used for
-   * testing code which consumes this property. If the property value changes,
-   * this results in a property change notification on the persona.
+   * { link Folks.ImDetails.im_addresses} property. It is intended to be used
+   * for testing code which consumes this property. If the property value
+   * changes, this results in a property change notification on the persona.
    *
    * @param im_addresses persona's new IM addresses
    * @since UNRELEASED
@@ -1030,9 +1032,9 @@ public class FolksDummy.FatPersona : FolksDummy.Persona,
    * Update persona's phone numbers.
    *
    * This simulates a backing-store-side update of the persona's
-   * { link PhoneDetails.phone_numbers} property. It is intended to be used for
-   * testing code which consumes this property. If the property value changes,
-   * this results in a property change notification on the persona.
+   * { link Folks.PhoneDetails.phone_numbers} property. It is intended to be
+   * used for testing code which consumes this property. If the property value
+   * changes, this results in a property change notification on the persona.
    *
    * @param phone_numbers persona's new phone numbers
    * @since UNRELEASED
@@ -1053,10 +1055,10 @@ public class FolksDummy.FatPersona : FolksDummy.Persona,
    * Update persona's postal addresses.
    *
    * This simulates a backing-store-side update of the persona's
-   * { link PostalAddressDetails.postal_addresses} property. It is intended to
-   * be used for testing code which consumes this property. If the property
-   * value changes, this results in a property change notification on the
-   * persona.
+   * { link Folks.PostalAddressDetails.postal_addresses} property. It is
+   * intended to be used for testing code which consumes this property. If the
+   * property value changes, this results in a property change notification on
+   * the persona.
    *
    * @param postal_addresses persona's new postal addresses
    * @since UNRELEASED
@@ -1079,9 +1081,9 @@ public class FolksDummy.FatPersona : FolksDummy.Persona,
    * Update persona's local IDs.
    *
    * This simulates a backing-store-side update of the persona's
-   * { link LocalIdDetails.local_ids} property. It is intended to be used for
-   * testing code which consumes this property. If the property value changes,
-   * this results in a property change notification on the persona.
+   * { link Folks.LocalIdDetails.local_ids} property. It is intended to be used
+   * for testing code which consumes this property. If the property value
+   * changes, this results in a property change notification on the persona.
    *
    * @param local_ids persona's new local IDs
    * @since UNRELEASED
@@ -1103,8 +1105,8 @@ public class FolksDummy.FatPersona : FolksDummy.Persona,
    * Update persona's status as a favourite.
    *
    * This simulates a backing-store-side update of the persona's
-   * { link FavouriteDetails.is_favourite} property. It is intended to be used
-   * for testing code which consumes this property. If the property value
+   * { link Folks.FavouriteDetails.is_favourite} property. It is intended to be
+   * used for testing code which consumes this property. If the property value
    * changes, this results in a property change notification on the persona.
    *
    * @param is_favourite persona's new status as a favourite
@@ -1123,9 +1125,9 @@ public class FolksDummy.FatPersona : FolksDummy.Persona,
    * Update persona's anti-links.
    *
    * This simulates a backing-store-side update of the persona's
-   * { link AntiLinkable.anti_links} property. It is intended to be used for
-   * testing code which consumes this property. If the property value changes,
-   * this results in a property change notification on the persona.
+   * { link Folks.AntiLinkable.anti_links} property. It is intended to be used
+   * for testing code which consumes this property. If the property value
+   * changes, this results in a property change notification on the persona.
    *
    * @param anti_links persona's new anti-links
    * @since UNRELEASED
diff --git a/backends/dummy/lib/dummy-persona-store.vala b/backends/dummy/lib/dummy-persona-store.vala
index 360ec06..a2284c7 100644
--- a/backends/dummy/lib/dummy-persona-store.vala
+++ b/backends/dummy/lib/dummy-persona-store.vala
@@ -40,15 +40,15 @@ using GLib;
  *
  * The main action performed with a dummy persona store is to change its set of
  * personas, adding and removing them dynamically to test client-side behaviour.
- * The client-side APIs ({ link PersonaStore.add_persona_from_details} and
- * { link PersonaStore.remove_persona}) should //not// be used for this.
+ * The client-side APIs ({ link Folks.PersonaStore.add_persona_from_details} and
+ * { link Folks.PersonaStore.remove_persona}) should //not// be used for this.
  * Instead, the mock APIs should be used:
  * { link FolksDummy.PersonaStore.freeze_personas_changed},
  * { link FolksDummy.PersonaStore.register_personas},
  * { link FolksDummy.PersonaStore.unregister_personas} and
  * { link FolksDummy.PersonaStore.thaw_personas_changed}. These can be used to
- * build up complex { link PersonaStore.personas_changed} signal emissions,
- * which are only emitted after the final call to
+ * build up complex { link Folks.PersonaStore.personas_changed} signal
+ * emissions, which are only emitted after the final call to
  * { link FolksDummy.PersonaStore.thaw_personas_changed}.
  *
  * The API in { link FolksDummy} is unstable and may change wildly. It is
@@ -709,15 +709,16 @@ public class FolksDummy.PersonaStore : Folks.PersonaStore
     }
 
   /**
-   * Type of a mock function for { link PersonaStore.add_persona_from_details}.
+   * Type of a mock function for
+   * { link Folks.PersonaStore.add_persona_from_details}.
    *
    * See { link FolksDummy.PersonaStore.add_persona_from_details_mock}.
    *
    * @param persona the persona being added to the store, as constructed from
-   * the details passed to { link PersonaStore.add_persona_from_details}.
+   * the details passed to { link Folks.PersonaStore.add_persona_from_details}.
    * @throws PersonaStoreError to be thrown from
-   * { link PersonaStore.add_persona_from_details}
-   * @returns delay to apply to the add persona operation (negative delays
+   * { link Folks.PersonaStore.add_persona_from_details}
+   * @return delay to apply to the add persona operation (negative delays
    * complete synchronously; zero delays complete in an idle callback; positive
    * delays complete after that many milliseconds)
    *
@@ -727,26 +728,27 @@ public class FolksDummy.PersonaStore : Folks.PersonaStore
       throws PersonaStoreError;
 
   /**
-   * Mock function for { link PersonaStore.add_persona_from_details}.
+   * Mock function for { link Folks.PersonaStore.add_persona_from_details}.
    *
    * This function is called whenever this store's
-   * { link PersonaStore.add_persona_from_details} method is called. It allows
-   * the caller to determine whether adding the given persona should fail, by
-   * throwing an error from this mock function. If no error is thrown from this
-   * function, adding the given persona will succeed. This is useful for testing
-   * error handling of calls to { link PersoneStore.add_persona_from_details}.
+   * { link Folks.PersonaStore.add_persona_from_details} method is called. It
+   * allows the caller to determine whether adding the given persona should
+   * fail, by throwing an error from this mock function. If no error is thrown
+   * from this function, adding the given persona will succeed. This is useful
+   * for testing error handling of calls to
+   * { link Folks.PersonaStore.add_persona_from_details}.
    *
    * The value returned by this function gives a delay which is imposed for
-   * completion of the { link PersonaStore.add_persona_from_details} call.
+   * completion of the { link Folks.PersonaStore.add_persona_from_details} call.
    * Negative delays result in the call completing synchronously, zero delays
    * result in completion in an idle callback, and positive delays result in
    * completion after that many milliseconds.
    *
    * If this is ``null``, all calls to
-   * { link PersonaStore.add_persona_from_details} will succeed.
+   * { link Folks.PersonaStore.add_persona_from_details} will succeed.
    *
    * This mock function may be changed at any time; changes will take effect for
-   * the next call to { link PersonaStore.add_persona_from_details}.
+   * the next call to { link Folks.PersonaStore.add_persona_from_details}.
    *
    * @since UNRELEASED
    */
@@ -756,14 +758,14 @@ public class FolksDummy.PersonaStore : Folks.PersonaStore
     }
 
   /**
-   * Type of a mock function for { link PersonaStore.remove_persona}.
+   * Type of a mock function for { link Folks.PersonaStore.remove_persona}.
    *
    * See { link FolksDummy.PersonaStore.remove_persona_mock}.
    *
    * @param persona the persona being removed from the store
    * @throws PersonaStoreError to be thrown from
-   * { link PersonaStore.remove_persona}
-   * @returns delay to apply to the remove persona operation (negative delays
+   * { link Folks.PersonaStore.remove_persona}
+   * @return delay to apply to the remove persona operation (negative delays
    * complete synchronously; zero delays complete in an idle callback; positive
    * delays complete after that many milliseconds)
    *
@@ -773,26 +775,27 @@ public class FolksDummy.PersonaStore : Folks.PersonaStore
       throws PersonaStoreError;
 
   /**
-   * Mock function for { link PersonaStore.remove_persona}.
+   * Mock function for { link Folks.PersonaStore.remove_persona}.
    *
    * This function is called whenever this store's
-   * { link PersonaStore.remove_persona} method is called. It allows
+   * { link Folks.PersonaStore.remove_persona} method is called. It allows
    * the caller to determine whether removing the given persona should fail, by
    * throwing an error from this mock function. If no error is thrown from this
    * function, removing the given persona will succeed. This is useful for
-   * testing error handling of calls to { link PersoneStore.remove_persona}.
+   * testing error handling of calls to
+   * { link Folks.PersonaStore.remove_persona}.
    *
    * The value returned by this function gives a delay which is imposed for
-   * completion of the { link PersonaStore.remove_persona} call.
+   * completion of the { link Folks.PersonaStore.remove_persona} call.
    * Negative delays result in the call completing synchronously, zero delays
    * result in completion in an idle callback, and positive delays result in
    * completion after that many milliseconds.
    *
-   * If this is ``null``, all calls to { link PersonaStore.remove_persona} will
-   * succeed.
+   * If this is ``null``, all calls to { link Folks.PersonaStore.remove_persona}
+   * will succeed.
    *
    * This mock function may be changed at any time; changes will take effect for
-   * the next call to { link PersonaStore.remove_persona}.
+   * the next call to { link Folks.PersonaStore.remove_persona}.
    *
    * @since UNRELEASED
    */
@@ -802,12 +805,13 @@ public class FolksDummy.PersonaStore : Folks.PersonaStore
     }
 
   /**
-   * Type of a mock function for { link PersonaStore.prepare}.
+   * Type of a mock function for { link Folks.PersonaStore.prepare}.
    *
    * See { link FolksDummy.PersonaStore.prepare_mock}.
    *
-   * @throws PersonaStoreError to be thrown from { link PersonaStore.prepare}
-   * @returns delay to apply to the prepare operation (negative delays
+   * @throws PersonaStoreError to be thrown from
+   * { link Folks.PersonaStore.prepare}
+   * @return delay to apply to the prepare operation (negative delays
    * complete synchronously; zero delays complete in an idle callback; positive
    * delays complete after that many milliseconds)
    *
@@ -816,28 +820,28 @@ public class FolksDummy.PersonaStore : Folks.PersonaStore
   public delegate int PrepareMock () throws PersonaStoreError;
 
   /**
-   * Mock function for { link PersonaStore.prepare}.
+   * Mock function for { link Folks.PersonaStore.prepare}.
    *
    * This function is called whenever this store's
-   * { link PersonaStore.prepare} method is called on an unprepared store. It
-   * allows the caller to determine whether preparing the store should fail, by
-   * throwing an error from this mock function. If no error is thrown from this
-   * function, preparing the store will succeed (and all future calls to
-   * { link PersonaStore.prepare} will return immediately without calling this
-   * mock function). This is useful for testing error handling of calls to
-   * { link PersoneStore.prepare}.
+   * { link Folks.PersonaStore.prepare} method is called on an unprepared store.
+   * It allows the caller to determine whether preparing the store should fail,
+   * by throwing an error from this mock function. If no error is thrown from
+   * this function, preparing the store will succeed (and all future calls to
+   * { link Folks.PersonaStore.prepare} will return immediately without calling
+   * this mock function). This is useful for testing error handling of calls to
+   * { link Folks.PersonaStore.prepare}.
    *
    * The value returned by this function gives a delay which is imposed for
-   * completion of the { link PersonaStore.prepare} call.
+   * completion of the { link Folks.PersonaStore.prepare} call.
    * Negative delays result in the call completing synchronously, zero delays
    * result in completion in an idle callback, and positive delays result in
    * completion after that many milliseconds.
    *
-   * If this is ``null``, all calls to { link PersonaStore.prepare} will
+   * If this is ``null``, all calls to { link Folks.PersonaStore.prepare} will
    * succeed.
    *
    * This mock function may be changed at any time; changes will take effect for
-   * the next call to { link PersonaStore.prepare}.
+   * the next call to { link Folks.PersonaStore.prepare}.
    *
    * @since UNRELEASED
    */
@@ -852,12 +856,12 @@ public class FolksDummy.PersonaStore : Folks.PersonaStore
    * Type of programmatically created personas.
    *
    * This is the type used to create new personas when
-   * { link PersonaStore.add_persona_from_details} is called. It must be a
+   * { link Folks.PersonaStore.add_persona_from_details} is called. It must be a
    * subtype of { link FolksDummy.Persona}.
    *
    * This may be modified at any time, with modifications taking effect for the
-   * next call to { link PersonaStore.add_persona_from_details} or
-   * { link PersonaStore.register_personas}.
+   * next call to { link Folks.PersonaStore.add_persona_from_details} or
+   * { link FolksDummy.PersonaStore.register_personas}.
    *
    * @since UNRELEASED
    */
@@ -880,9 +884,9 @@ public class FolksDummy.PersonaStore : Folks.PersonaStore
    *
    * This sets the capabilities of the store, as if they were changed on a
    * backing store somewhere. This is intended to be used for testing code which
-   * depends on the values of { link PersonaStore.can_add_personas},
-   * { link PersonaStore.can_alias_personas} and
-   * { link PersonaStore.can_remove_personas}.
+   * depends on the values of { link Folks.PersonaStore.can_add_personas},
+   * { link Folks.PersonaStore.can_alias_personas} and
+   * { link Folks.PersonaStore.can_remove_personas}.
    *
    * @param can_add_personas whether the store can handle adding personas
    * @param can_alias_personas whether the store can handle and update
@@ -921,14 +925,15 @@ public class FolksDummy.PersonaStore : Folks.PersonaStore
    * Freeze persona changes in the store.
    *
    * This freezes externally-visible changes to the set of personas in the store
-   * until { link PersonaStore.thaw_personas_changed} is called, at which point
-   * all pending changes are made visible in the { link PersonaStore.personas}
-   * property and by emitting { link PersonaStore.personas_changed}.
+   * until { link FolksDummy.PersonaStore.thaw_personas_changed} is called, at
+   * which point all pending changes are made visible in the
+   * { link Folks.PersonaStore.personas} property and by emitting
+   * { link Folks.PersonaStore.personas_changed}.
    *
-   * Calls to { link PersonaStore.freeze_personas_changed} and
-   * { link PersonaStore.thaw_personas_changed} must be well-nested. Pending
-   * changes will only be committed after the final call to
-   * { link PersonaStore.thaw_personas_changed}.
+   * Calls to { link FolksDummy.PersonaStore.freeze_personas_changed} and
+   * { link FolksDummy.PersonaStore.thaw_personas_changed} must be well-nested.
+   * Pending changes will only be committed after the final call to
+   * { link FolksDummy.PersonaStore.thaw_personas_changed}.
    *
    * @see PersonaStore.thaw_personas_changed
    * @since UNRELEASED
@@ -942,9 +947,9 @@ public class FolksDummy.PersonaStore : Folks.PersonaStore
    * Thaw persona changes in the store.
    *
    * This thaws externally-visible changes to the set of personas in the store.
-   * If the number of calls to { link PersonaStore.thaw_personas_changed}
-   * matches the number of calls to
-   * { link PersonaStore.freeze_personas_changed}, all
+   * If the number of calls to
+   * { link FolksDummy.PersonaStore.thaw_personas_changed} matches the number of
+   * calls to { link FolksDummy.PersonaStore.freeze_personas_changed}, all
    * pending changes are committed and made externally-visible.
    *
    * @see PersonaStore.freeze_personas_changed
@@ -971,14 +976,14 @@ public class FolksDummy.PersonaStore : Folks.PersonaStore
    *
    * This registers a set of personas as if they had just appeared in the
    * backing store. If the persona store is not frozen (see
-   * { link PersonaStore.freeze_personas_changed}) the changes are made
-   * externally visible on the store immediately (e.g. in the
-   * { link PersonaStore.personas} property and through a
-   * { link PersonaStore.personas_changed} signal). If the store is frozen, the
-   * changes will be pending until the store is next unfrozen.
+   * { link FolksDummy.PersonaStore.freeze_personas_changed}) the changes are
+   * made externally visible on the store immediately (e.g. in the
+   * { link Folks.PersonaStore.personas} property and through a
+   * { link Folks.PersonaStore.personas_changed} signal). If the store is
+   * frozen, the changes will be pending until the store is next unfrozen.
    *
    * All elements in the @personas set be of type
-   * { link PersonaStore.persona_type}.
+   * { link FolksDummy.PersonaStore.persona_type}.
    *
    * @param personas set of personas to register
    *
@@ -1022,11 +1027,11 @@ public class FolksDummy.PersonaStore : Folks.PersonaStore
    *
    * This unregisters a set of personas as if they had just disappeared from the
    * backing store. If the persona store is not frozen (see
-   * { link PersonaStore.freeze_personas_changed}) the changes are made
-   * externally visible on the store immediately (e.g. in the
-   * { link PersonaStore.personas} property and through a
-   * { link PersonaStore.personas_changed} signal). If the store is frozen, the
-   * changes will be pending until the store is next unfrozen.
+   * { link FolksDummy.PersonaStore.freeze_personas_changed}) the changes are
+   * made externally visible on the store immediately (e.g. in the
+   * { link Folks.PersonaStore.personas} property and through a
+   * { link Folks.PersonaStore.personas_changed} signal). If the store is
+   * frozen, the changes will be pending until the store is next unfrozen.
    *
    * @param personas set of personas to unregister
    *
@@ -1066,11 +1071,11 @@ public class FolksDummy.PersonaStore : Folks.PersonaStore
   /**
    * Reach quiescence on the store.
    *
-   * If the { link PersonaStore.prepare} method has already been called on the
-   * store, this causes the store to signal that it has reached quiescence
+   * If the { link Folks.PersonaStore.prepare} method has already been called on
+   * the store, this causes the store to signal that it has reached quiescence
    * immediately. If the store has not yet been prepared, this will set a flag
    * to ensure that quiescence is reached as soon as
-   * { link PersonaStore.prepare} is called.
+   * { link Folks.PersonaStore.prepare} is called.
    *
    * @since UNRELEASED
    */
@@ -1093,10 +1098,10 @@ public class FolksDummy.PersonaStore : Folks.PersonaStore
     }
 
   /**
-   * Update the { link PersonaStore.is_user_set_default} property.
+   * Update the { link Folks.PersonaStore.is_user_set_default} property.
    *
    * Backend method for use by test code to simulate a backing-store-driven
-   * change in the { link PersonaStore.is_user_set_default} property.
+   * change in the { link Folks.PersonaStore.is_user_set_default} property.
    *
    * @param is_user_set_default new value for the property
    *
@@ -1110,10 +1115,10 @@ public class FolksDummy.PersonaStore : Folks.PersonaStore
     }
 
   /**
-   * Update the { link PersonaStore.trust_level} property.
+   * Update the { link Folks.PersonaStore.trust_level} property.
    *
    * Backend method for use by test code to simulate a backing-store-driven
-   * change in the { link PersonaStore.trust_level} property.
+   * change in the { link Folks.PersonaStore.trust_level} property.
    *
    * @param trust_level new value for the property
    *
diff --git a/backends/dummy/lib/dummy-persona.vala b/backends/dummy/lib/dummy-persona.vala
index 071cbe0..29e61b6 100644
--- a/backends/dummy/lib/dummy-persona.vala
+++ b/backends/dummy/lib/dummy-persona.vala
@@ -32,7 +32,8 @@ using GLib;
  * which implements all available interfaces.
  *
  * There are two sides to this class’ interface: the normal methods required by
- * { link Folks.Persona}, such as { link Persona.linkable_property_to_links},
+ * { link Folks.Persona}, such as
+ * { link Folks.Persona.linkable_property_to_links},
  * and the backend methods which should be called by test driver code to
  * simulate changes in the backing store providing this persona, such as
  * { link FolksDummy.Persona.update_writeable_properties}.
@@ -75,13 +76,13 @@ public class FolksDummy.Persona : Folks.Persona
   /**
    * Create a new persona.
    *
-   * Create a new persona for the { link PersonaStore} ``store``, with the given
-   * construct-only properties.
+   * Create a new persona for the { link FolksDummy.PersonaStore} ``store``,
+   * with the given construct-only properties.
    *
-   * The persona’s { link Persona.writeable_properties} are initialised to the
-   * given ``store``’s { link PersonaStore.always_writeable_properties}. They
-   * may be updated afterwards using
-   * { link FolksDummy.Persona.update_writeable_properties}.
+   * The persona’s { link Folks.Persona.writeable_properties} are initialised to
+   * the given ``store``’s
+   * { link Folks.PersonaStore.always_writeable_properties}. They may be updated
+   * afterwards using { link FolksDummy.Persona.update_writeable_properties}.
    *
    * @param store the store which will contain the persona
    * @param contact_id a unique free-form string identifier for the persona
@@ -185,9 +186,9 @@ public class FolksDummy.Persona : Folks.Persona
   /**
    * Update the persona’s set of writeable properties.
    *
-   * Update the { link Persona.writeable_properties} property to contain the
-   * union of { link PersonaStore.always_writeable_properties} from the
-   * persona’s store, and the given ``writeable_properties``.
+   * Update the { link Folks.Persona.writeable_properties} property to contain
+   * the union of { link Folks.PersonaStore.always_writeable_properties} from
+   * the persona’s store, and the given ``writeable_properties``.
    *
    * This should be used to simulate a change in the backing store for the
    * persona which affects the writeability of one or more of its properties.
@@ -233,7 +234,7 @@ public class FolksDummy.Persona : Folks.Persona
    * Delay between property changes and notifications.
    *
    * This sets an optional delay between client code requesting a property
-   * change (e.g. by calling { link NameDetails.change_nickname}) and the
+   * change (e.g. by calling { link Folks.NameDetails.change_nickname}) and the
    * property change taking place and a { link Object.notify} signal being
    * emitted for it.
    *
@@ -254,7 +255,8 @@ public class FolksDummy.Persona : Folks.Persona
    * This is called by { link FolksDummy.Persona.change_property} after the
    * { link FolksDummy.Persona.property_change_delay} has expired. It must
    * effect the property change in the simulated backing store, for example by
-   * calling an ‘update’ method such as { link FatPersona.update_nickname}.
+   * calling an ‘update’ method such as
+   * { link FolksDummy.FatPersona.update_nickname}.
    *
    * @since UNRELEASED
    */
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]