minor documentation tweaks. #104

This commit is contained in:
John Evans 2013-10-27 14:28:22 -04:00
commit 119dc0dfcd

View file

@ -1209,7 +1209,7 @@ class JPEG2000SignatureBox(Jp2kBox):
offset of the box from the start of the file. offset of the box from the start of the file.
longname : str longname : str
more verbose description of the box. more verbose description of the box.
signature : byte signature : tuple
Four-byte tuple identifying the file as JPEG 2000. Four-byte tuple identifying the file as JPEG 2000.
""" """
def __init__(self, signature=(13, 10, 135, 10), length=0, offset=-1): def __init__(self, signature=(13, 10, 135, 10), length=0, offset=-1):
@ -1807,7 +1807,7 @@ class LabelBox(Jp2kBox):
longname : str longname : str
more verbose description of the box. more verbose description of the box.
label : str label : str
Label Textual label.
""" """
def __init__(self, label, length=0, offset=-1): def __init__(self, label, length=0, offset=-1):
Jp2kBox.__init__(self, box_id='lbl ', longname='Label') Jp2kBox.__init__(self, box_id='lbl ', longname='Label')
@ -2179,9 +2179,12 @@ class UUIDBox(Jp2kBox):
more verbose description of the box. more verbose description of the box.
uuid : uuid.UUID uuid : uuid.UUID
16-byte UUID 16-byte UUID
data : bytes or dict or ElementTree.Element raw_data : byte array
Vendor-specific data. Exif UUIDs are interpreted as dictionaries. Sequence of uninterpreted bytes as read from the file.
XMP UUIDs are interpreted as standard XML. data : object
Specific to each type of UUID. There are handlers for XMP, Exif, and
generic (unknown) UUIDs. In the case of XMP and Exif UUIDs, this is
the interpreted version of raw_data.
References References
---------- ----------
@ -2195,9 +2198,6 @@ class UUIDBox(Jp2kBox):
---------- ----------
the_uuid : uuid.UUID the_uuid : uuid.UUID
Identifies the type of UUID box. Identifies the type of UUID box.
data : object
Specific to each type of UUID. There are handlers for XMP, Exif,
and unknown UUIDs.
raw_data : byte array raw_data : byte array
Sequence of uninterpreted bytes as read from the file. Sequence of uninterpreted bytes as read from the file.
length : int length : int