← Back to branch summary

~ubuntu-branches/ubuntu/quantal/folks/quantal

« back to all changes in this revision

Viewing changes to folks/abstract-field-details.vala

  • Committer: Package Import Robot
  • Author(s): Robert Ancell
  • Date: 2012-09-12 09:48:10 UTC
  • mfrom: (1.6.2)
  • Revision ID: package-import@ubuntu.com-20120912094810-6zlx8889hcovxj7p
Tags: 0.7.4.1-0ubuntu1
* New upstream bugfix release
* debian/control:
  - Bump build-depends on libglib2.0-dev, valac-0.18, libvala-0.18-dev
* debian/libfolks-eds25.symbols:
* debian/libfolks25.symbols:
  - Updated

Show diffs side-by-side

added added

removed removed

Lines of Context:
folks/abstract-field-details.vala
29
29
 * Some contact details, like phone numbers or URLs, can have some
30
30
 * extra details associated with them.
31
31
 * For instance, a phone number expressed in vcard notation as
32
 
 * `tel;type=work,voice:(111) 555-1234` would be represented as
 
32
 * ``tel;type=work,voice:(111) 555-1234`` would be represented as
33
33
 * a AbstractFieldDetails with value "(111) 555-1234" and with parameters
34
 
 * `['type': ('work', 'voice')]`.
 
34
 * ``['type': ('work', 'voice')]``.
35
35
 *
36
36
 * The parameter name "type" with values "work", "home", or "other" are common
37
37
 * amongst most vCard attributes (and thus most AbstractFieldDetails-derived
161
161
   * Get the values for a parameter
162
162
   *
163
163
   * @param parameter_name the parameter name
164
 
   * @return a collection of values for `parameter_name` or `null` (i.e. no
 
164
   * @return a collection of values for ``parameter_name`` or ``null`` (i.e. no
165
165
   * collection) if there are no such parameters.
166
166
   *
167
167
   * @since 0.6.0
179
179
  /**
180
180
   * Add a new value for a parameter.
181
181
   *
182
 
   * If there is already a parameter called `parameter_name` then
183
 
   * `parameter_value` is added to the existing ones.
 
182
   * If there is already a parameter called ``parameter_name`` then
 
183
   * ``parameter_value`` is added to the existing ones.
184
184
   *
185
185
   * @param parameter_name the name of the parameter
186
186
   * @param parameter_value the value to add
195
195
  /**
196
196
   * Set the value of a parameter.
197
197
   *
198
 
   * Sets the parameter called `parameter_name` to be `parameter_value`.
 
198
   * Sets the parameter called ``parameter_name`` to be ``parameter_value``.
199
199
   * If there were already parameters with the same name they are replaced.
200
200
   *
201
201
   * @param parameter_name the name of the parameter
212
212
  /**
213
213
   * Extend the existing parameters.
214
214
   *
215
 
   * Merge the parameters from `additional` into the existing ones.
 
215
   * Merge the parameters from ``additional`` into the existing ones.
216
216
   *
217
217
   * @param additional the parameters to add
218
218
   *