← Back to branch summary

~ubuntu-branches/ubuntu/maverick/evolution-data-server/maverick-proposed

« back to all changes in this revision

Viewing changes to docs/reference/addressbook/libebook/xml/e-address-western.xml

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.1.79 upstream) (1.6.12 experimental)
  • Revision ID: james.westby@ubuntu.com-20100517170206-4ufr52vwrhh26yh0
Tags: 2.30.1-1ubuntu1
https://launchpad.net/bugs/42199
https://launchpad.net/bugs/229669
https://launchpad.net/bugs/173703
https://launchpad.net/bugs/360344
https://launchpad.net/bugs/508494
* Merge from debian experimental. Remaining change:
  (LP: #42199, #229669, #173703, #360344, #508494)
  + debian/control:
    - add Vcs-Bzr tag
    - don't use libgnome
    - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  + debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    - use the upstream versioning, not a Debian-specific one 
  + debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
    debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
    - install html documentation
  + debian/rules:
    - don't build documentation it's shipped with the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/addressbook/libebook/xml/e-address-western.xml
1
 
<?xml version="1.0"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
3
 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
 
<refentry id="libebook-EAddressWestern">
5
 
<refmeta>
6
 
<refentrytitle role="top_of_page" id="libebook-EAddressWestern.top_of_page">e-address-western</refentrytitle>
7
 
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>
9
 
  LIBEBOOK Library
10
 
</refmiscinfo>
11
 
</refmeta>
12
 
<refnamediv>
13
 
<refname>e-address-western</refname>
14
 
<refpurpose>A physical address in the format used in the Western hemisphere.</refpurpose>
15
 
</refnamediv>
16
 
 
17
 
<refsynopsisdiv id="libebook-EAddressWestern.synopsis" role="synopsis">
18
 
<title role="synopsis.title">Synopsis</title>
19
 
 
20
 
<synopsis>                    <link linkend="EAddressWestern">EAddressWestern</link>;
21
 
<link linkend="EAddressWestern"><returnvalue>EAddressWestern</returnvalue></link> *   <link linkend="e-address-western-parse">e_address_western_parse</link>             (<parameter>const <link linkend="gchar"><type>gchar</type></link> *in_address</parameter>);
22
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-address-western-free">e_address_western_free</link>              (<parameter><link linkend="EAddressWestern"><type>EAddressWestern</type></link> *eaw</parameter>);
23
 
</synopsis>
24
 
</refsynopsisdiv>
25
 
 
26
 
<refsect1 id="libebook-EAddressWestern.description" role="desc">
27
 
<title role="desc.title">Description</title>
28
 
<para>
29
 
</para>
30
 
</refsect1>
31
 
<refsect1 id="libebook-EAddressWestern.details" role="details">
32
 
<title role="details.title">Details</title>
33
 
<refsect2 id="EAddressWestern" role="struct">
34
 
<title>EAddressWestern</title>
35
 
<indexterm zone="EAddressWestern"><primary>EAddressWestern</primary></indexterm>
36
 
<programlisting>typedef struct {
37
 
        /* Public */
38
 
        gchar *po_box;
39
 
        gchar *extended;  /* I'm not sure what this is. */
40
 
        gchar *street;
41
 
        gchar *locality;  /* For example, the city or town. */
42
 
        gchar *region;&#160;/* The state or province. */
43
 
        gchar *postal_code;
44
 
        gchar *country;
45
 
} EAddressWestern;
46
 
</programlisting>
47
 
<para>
48
 
</para></refsect2>
49
 
<refsect2 id="e-address-western-parse" role="function">
50
 
<title>e_address_western_parse ()</title>
51
 
<indexterm zone="e-address-western-parse"><primary>e_address_western_parse</primary></indexterm>
52
 
<programlisting><link linkend="EAddressWestern"><returnvalue>EAddressWestern</returnvalue></link> *   e_address_western_parse             (<parameter>const <link linkend="gchar"><type>gchar</type></link> *in_address</parameter>);</programlisting>
53
 
<para>
54
 
Parses a string representing a mailing address into a
55
 
structure of type <link linkend="EAddressWestern"><type>EAddressWestern</type></link>.</para>
56
 
<variablelist role="params">
57
 
<varlistentry><term><parameter>in_address</parameter>&#160;:</term>
58
 
<listitem><simpara>a string representing a mailing address
59
 
</simpara></listitem></varlistentry>
60
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A new <link linkend="EAddressWestern"><type>EAddressWestern</type></link> structure, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if the parsing failed.
61
 
</simpara></listitem></varlistentry>
62
 
</variablelist></refsect2>
63
 
<refsect2 id="e-address-western-free" role="function">
64
 
<title>e_address_western_free ()</title>
65
 
<indexterm zone="e-address-western-free"><primary>e_address_western_free</primary></indexterm>
66
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_address_western_free              (<parameter><link linkend="EAddressWestern"><type>EAddressWestern</type></link> *eaw</parameter>);</programlisting>
67
 
<para>
68
 
Frees <parameter>eaw</parameter> and its contents.</para>
69
 
<variablelist role="params">
70
 
<varlistentry><term><parameter>eaw</parameter>&#160;:</term>
71
 
<listitem><simpara>an <link linkend="EAddressWestern"><type>EAddressWestern</type></link>
72
 
</simpara></listitem></varlistentry>
73
 
</variablelist></refsect2>
74
 
 
75
 
</refsect1>
76
 
 
77
 
</refentry>