diff options
author | Olivier Tilloy <olivier@tilloy.net> | 2010-02-16 17:10:07 +0100 |
---|---|---|
committer | Olivier Tilloy <olivier@tilloy.net> | 2010-02-16 17:10:07 +0100 |
commit | 6f165359c2e67e35b328fdb5b6ad6aa8f22cdab9 (patch) | |
tree | 42ef9134b7a9386680eab1d5bb6e3e76d539470e /doc/api.rst | |
parent | b2b0165fa924426fa8bb17a61c7f655fd5ccac7e (diff) | |
parent | 871d24f9d959fe5cf9664bbb4f00ea94ff9b58f0 (diff) | |
download | pyexiv2-6f165359c2e67e35b328fdb5b6ad6aa8f22cdab9.tar.gz |
Complete documentation generated with sphinx.
Diffstat (limited to 'doc/api.rst')
-rw-r--r-- | doc/api.rst | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/doc/api.rst b/doc/api.rst new file mode 100644 index 0000000..3a26568 --- /dev/null +++ b/doc/api.rst @@ -0,0 +1,58 @@ +API documentation +================= + +pyexiv2 +####### + +.. module:: pyexiv2 +.. autodata:: version_info +.. autodata:: __version__ +.. autodata:: exiv2_version_info +.. autodata:: __exiv2_version__ + +pyexiv2.metadata +################ + +.. module:: pyexiv2.metadata +.. autoclass:: ImageMetadata + :members: read, write, dimensions, mime_type, exif_keys, iptc_keys, + xmp_keys, __getitem__, __setitem__, __delitem__, previews, copy + +pyexiv2.exif +############ + +.. module:: pyexiv2.exif +.. autoexception:: ExifValueError +.. autoclass:: ExifTag + :members: key, type, name, label, description, section_name, + section_description, raw_value, value, human_value + +pyexiv2.iptc +############ + +.. module:: pyexiv2.iptc +.. autoexception:: IptcValueError +.. autoclass:: IptcTag + :members: key, type, name, title, description, photoshop_name, repeatable, + record_name, record_description, raw_values, values + +pyexiv2.xmp +########### + +.. module:: pyexiv2.xmp +.. autoexception:: XmpValueError +.. autoclass:: XmpTag + :members: key, type, name, title, description, raw_value, value + +pyexiv2.utils +############# + +.. module:: pyexiv2.utils +.. autofunction:: undefined_to_string +.. autofunction:: string_to_undefined + +.. autoclass:: Rational + :members: numerator, denominator, from_string, to_float, __eq__ +.. autoclass:: GPSCoordinate + :members: degrees, minutes, seconds, direction, from_string, __eq__, __str__ + |