GNOME.org
 

[folks] docs: Fix incorrect @since lines in documentation comments

commit f2b54418bd5839586ca360642a76b47ca070eaed
Author: Philip Withnall <philip withnall collabora co uk>
Date:   Mon May 25 16:52:39 2015 +0100

    docs: Fix incorrect @since lines in documentation comments

 backends/eds/lib/edsf-persona.vala |    6 +++---
 folks/extended-info.vala           |   16 ++++++++--------
 folks/individual.vala              |    6 +++---
 folks/persona-store.vala           |    2 +-
 folks/query.vala                   |   12 ++++++------
 folks/search-view.vala             |   22 +++++++++++-----------
 folks/simple-query.vala            |   10 +++++-----
 7 files changed, 37 insertions(+), 37 deletions(-)
---
diff --git a/backends/eds/lib/edsf-persona.vala b/backends/eds/lib/edsf-persona.vala
index aa715b0..c7bcf12 100644
--- a/backends/eds/lib/edsf-persona.vala
+++ b/backends/eds/lib/edsf-persona.vala
@@ -366,7 +366,7 @@ public class Edsf.Persona : Folks.Persona,
   /**
    * { inheritDoc}
    *
-   * @since UNRELEASED
+   * @since 0.11.0
    */
   public ExtendedFieldDetails? get_extended_field (string name)
     {
@@ -376,7 +376,7 @@ public class Edsf.Persona : Folks.Persona,
   /**
    * { inheritDoc}
    *
-   * @since UNRELEASED
+   * @since 0.11.0
    */
   public async void change_extended_field (
       string name, ExtendedFieldDetails value) throws PropertyError
@@ -387,7 +387,7 @@ public class Edsf.Persona : Folks.Persona,
   /**
    * { inheritDoc}
    *
-   * @since UNRELEASED
+   * @since 0.11.0
    */
   public async void remove_extended_field (string name) throws PropertyError
     {
diff --git a/folks/extended-info.vala b/folks/extended-info.vala
index 0d81805..b170aa0 100644
--- a/folks/extended-info.vala
+++ b/folks/extended-info.vala
@@ -32,7 +32,7 @@ using Gee;
  * See { link Folks.AbstractFieldDetails} for details on common parameter names
  * and values.
  *
- * @since UNRELEASED
+ * @since 0.11.0
  */
 public class Folks.ExtendedFieldDetails : AbstractFieldDetails<string>
 {
@@ -46,7 +46,7 @@ public class Folks.ExtendedFieldDetails : AbstractFieldDetails<string>
    *
    * @return a new ExtendedFieldDetails
    *
-   * @since UNRELEASED
+   * @since 0.11.0
    */
   public ExtendedFieldDetails (string value,
       MultiMap<string, string>? parameters = null)
@@ -59,7 +59,7 @@ public class Folks.ExtendedFieldDetails : AbstractFieldDetails<string>
   /**
    * { inheritDoc}
    *
-   * @since UNRELEASED
+   * @since 0.11.0
    */
   public override bool equal (AbstractFieldDetails<string> that)
     {
@@ -69,7 +69,7 @@ public class Folks.ExtendedFieldDetails : AbstractFieldDetails<string>
   /**
    * { inheritDoc}
    *
-   * @since UNRELEASED
+   * @since 0.11.0
    */
   public override uint hash ()
     {
@@ -102,7 +102,7 @@ public class Folks.ExtendedFieldDetails : AbstractFieldDetails<string>
  * contact’s anniversary. That should be added in a separate interface in
  * libfolks.
  *
- * @since UNRELEASED
+ * @since 0.11.0
  */
 public interface Folks.ExtendedInfo : Object
 {
@@ -112,7 +112,7 @@ public interface Folks.ExtendedInfo : Object
    * @return The value of the extended field, which may be empty, or `null` if
    *   the field is not set
    *
-   * @since UNRELEASED
+   * @since 0.11.0
    */
   public abstract ExtendedFieldDetails? get_extended_field (string name);
 
@@ -123,7 +123,7 @@ public interface Folks.ExtendedInfo : Object
    * @param value new value for the arbitrary field
    * @throws PropertyError if setting the value failed
    *
-   * @since UNRELEASED
+   * @since 0.11.0
    */
   public virtual async void change_extended_field (
       string name, ExtendedFieldDetails value) throws PropertyError
@@ -139,7 +139,7 @@ public interface Folks.ExtendedInfo : Object
    * @param name name of the arbitrary field to remove
    * @throws PropertyError if removing the property failed
    *
-   * @since UNRELEASED
+   * @since 0.11.0
    */
   public virtual async void remove_extended_field (string name)
       throws PropertyError
diff --git a/folks/individual.vala b/folks/individual.vala
index cdabc7f..88d6437 100644
--- a/folks/individual.vala
+++ b/folks/individual.vala
@@ -987,7 +987,7 @@ public class Folks.Individual : Object,
   /**
    * { inheritDoc}
    *
-   * @since UNRELEASED
+   * @since 0.11.0
    */
   public ExtendedFieldDetails? get_extended_field (string name)
     {
@@ -1014,7 +1014,7 @@ public class Folks.Individual : Object,
   /**
    * { inheritDoc}
    *
-   * @since UNRELEASED
+   * @since 0.11.0
    */
   public async void change_extended_field (
       string name, ExtendedFieldDetails value) throws PropertyError
@@ -1067,7 +1067,7 @@ public class Folks.Individual : Object,
   /**
    * { inheritDoc}
    *
-   * @since UNRELEASED
+   * @since 0.11.0
    */
   public async void remove_extended_field (string name) throws PropertyError
     {
diff --git a/folks/persona-store.vala b/folks/persona-store.vala
index bf437f1..30941c1 100644
--- a/folks/persona-store.vala
+++ b/folks/persona-store.vala
@@ -316,7 +316,7 @@ public enum Folks.PersonaDetail
   /**
    * Field for { link ExtendedFieldDetails}.
    *
-   * @since UNRELEASED
+   * @since 0.11.0
    */
   EXTENDED_INFO,
 }
diff --git a/folks/query.vala b/folks/query.vala
index 7ed8d64..9b844ef 100644
--- a/folks/query.vala
+++ b/folks/query.vala
@@ -31,7 +31,7 @@ using GLib;
  * matches on receiving this signal.
  *
  * @see SearchView
- * @since UNRELEASED
+ * @since 0.11.0
  */
 public abstract class Folks.Query : Object
 {
@@ -43,7 +43,7 @@ public abstract class Folks.Query : Object
    * These are ordered approximately by descending match likeliness to speed up
    * calls to { link is_match} when used as-is.
    *
-   * @since UNRELEASED
+   * @since 0.11.0
    */
   public static const string MATCH_FIELDS_NAMES[] =
     {
@@ -61,7 +61,7 @@ public abstract class Folks.Query : Object
    * These are ordered approximately by descending match likeliness to speed up
    * calls to { link is_match} when used as-is.
    *
-   * @since UNRELEASED
+   * @since 0.11.0
    */
   public static const string MATCH_FIELDS_ADDRESSES[] =
     {
@@ -81,7 +81,7 @@ public abstract class Folks.Query : Object
    * These are ordered approximately by descending match likeliness to speed up
    * calls to { link is_match} when used as-is.
    *
-   * @since UNRELEASED
+   * @since 0.11.0
    */
   public static const string MATCH_FIELDS_MISC[] =
     {
@@ -106,7 +106,7 @@ public abstract class Folks.Query : Object
    *
    * Default value is { link Query.MATCH_FIELDS_NAMES}.
    *
-   * @since UNRELEASED
+   * @since 0.11.0
    * @see PersonaDetail
    * @see PersonaStore.detail_key
    * @see Query.MATCH_FIELDS_NAMES
@@ -134,7 +134,7 @@ public abstract class Folks.Query : Object
    * @param individual an { link Individual} to match against
    * @return a positive integer if the individual matches this query, or zero
    *   if they do not match; higher numbers indicate a better match
-   * @since UNRELEASED
+   * @since 0.11.0
    */
   public abstract uint is_match (Individual individual);
 }
diff --git a/folks/search-view.vala b/folks/search-view.vala
index 6755e17..b8af528 100644
--- a/folks/search-view.vala
+++ b/folks/search-view.vala
@@ -40,7 +40,7 @@ using GLib;
  * For live results, continue listening to the
  * { link SearchView.individuals_changed_detailed} signal.
  *
- * @since UNRELEASED
+ * @since 0.11.0
  */
 public class Folks.SearchView : Object
 {
@@ -50,7 +50,7 @@ public class Folks.SearchView : Object
   /**
    * The { link IndividualAggregator} that this view is based upon.
    *
-   * @since UNRELEASED
+   * @since 0.11.0
    */
   public IndividualAggregator aggregator
     {
@@ -69,7 +69,7 @@ public class Folks.SearchView : Object
    * de-bouncing to ensure re-evaluation only happens when (for example) the
    * user has stopped typing a new query.
    *
-   * @since UNRELEASED
+   * @since 0.11.0
    */
   public Query query
     {
@@ -113,7 +113,7 @@ public class Folks.SearchView : Object
    * property is valid once { link SearchView.prepare} is finished and this
    * { link SearchView} may be unreferenced and ignored afterward.
    *
-   * @since UNRELEASED
+   * @since 0.11.0
    */
   public SortedSet<Individual> individuals
     {
@@ -125,7 +125,7 @@ public class Folks.SearchView : Object
    * Whether { link IndividualAggregator.prepare} has successfully completed for
    * this view's aggregator.
    *
-   * @since UNRELEASED
+   * @since 0.11.0
    */
   public bool is_prepared
     {
@@ -140,7 +140,7 @@ public class Folks.SearchView : Object
    * It's guaranteed that this property's value will only ever change after
    * { link SearchView.is_prepared} has changed to ``true``.
    *
-   * @since UNRELEASED
+   * @since 0.11.0
    */
   public bool is_quiescent
     {
@@ -173,7 +173,7 @@ public class Folks.SearchView : Object
    * @param removed a set of { link Individual}s removed from the search view
    *
    * @see IndividualAggregator.individuals_changed_detailed
-   * @since UNRELEASED
+   * @since 0.11.0
    */
   public signal void individuals_changed_detailed (SortedSet<Individual> added,
       SortedSet<Individual> removed);
@@ -187,7 +187,7 @@ public class Folks.SearchView : Object
    * @param query query to match upon
    * @param aggregator the { link IndividualAggregator} to match within
    *
-   * @since UNRELEASED
+   * @since 0.11.0
    */
   public SearchView (IndividualAggregator aggregator, Query query)
     {
@@ -227,7 +227,7 @@ public class Folks.SearchView : Object
    *
    * @throws GLib.Error if preparation failed
    *
-   * @since UNRELEASED
+   * @since 0.11.0
    */
   public async void prepare () throws GLib.Error
     {
@@ -274,7 +274,7 @@ public class Folks.SearchView : Object
    * calls might return before the first one. (Though they will be safe in every
    * other respect.)
    *
-   * @since UNRELEASED
+   * @since 0.11.0
    * @throws GLib.Error if unpreparing the backend-specific services failed —
    * this will be a backend-specific error
    */
@@ -304,7 +304,7 @@ public class Folks.SearchView : Object
    * search results, e.g. if the user requests a refresh.
    *
    * @throws GLib.Error if matching failed
-   * @since UNRELEASED
+   * @since 0.11.0
    */
   public async void refresh () throws GLib.Error
     {
diff --git a/folks/simple-query.vala b/folks/simple-query.vala
index eccfe3e..2b3f188 100644
--- a/folks/simple-query.vala
+++ b/folks/simple-query.vala
@@ -33,7 +33,7 @@ using GLib;
  * in phone numbers.
  *
  * @see SearchView
- * @since UNRELEASED
+ * @since 0.11.0
  */
 public class Folks.SimpleQuery : Folks.Query
 {
@@ -47,7 +47,7 @@ public class Folks.SimpleQuery : Folks.Query
    * de-bouncing to ensure re-evaluation only happens when (for example) the
    * user has stopped typing a new query.
    *
-   * @since UNRELEASED
+   * @since 0.11.0
    */
   public string query_string
     {
@@ -77,7 +77,7 @@ public class Folks.SimpleQuery : Folks.Query
    * locale will be used. To perform transliteration for no specific locale,
    * use `C`.
    *
-   * @since UNRELEASED
+   * @since 0.11.0
    */
   public string? query_locale
     {
@@ -124,7 +124,7 @@ public class Folks.SimpleQuery : Folks.Query
    * { link PersonaDetail} and { link PersonaStore.detail_key} for pre-defined
    * field names.
    *
-   * @since UNRELEASED
+   * @since 0.11.0
    */
   public SimpleQuery (
       string query_string,
@@ -147,7 +147,7 @@ public class Folks.SimpleQuery : Folks.Query
   /**
    * { inheritDoc}
    *
-   * @since UNRELEASED
+   * @since 0.11.0
    */
   public override uint is_match (Individual individual)
     {
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]