diff --git a/DiscImageChef.DiscImages/ChangeLog b/DiscImageChef.DiscImages/ChangeLog index 1f45d6662..d2f9e119c 100644 --- a/DiscImageChef.DiscImages/ChangeLog +++ b/DiscImageChef.DiscImages/ChangeLog @@ -1,3 +1,8 @@ +2015-12-06 Natalia Portillo + + * ImagePlugin.cs: + Added documentation. + 2015-12-06 Natalia Portillo * CDRWin.cs: diff --git a/DiscImageChef.DiscImages/ImagePlugin.cs b/DiscImageChef.DiscImages/ImagePlugin.cs index bf9714cd5..51bba52be 100644 --- a/DiscImageChef.DiscImages/ImagePlugin.cs +++ b/DiscImageChef.DiscImages/ImagePlugin.cs @@ -467,22 +467,48 @@ namespace DiscImageChef.ImagePlugins public string TrackDescription; /// Indexes, 00 to 99 and sector offset public Dictionary Indexes; + /// Which file stores this track public string TrackFile; + /// Starting at which byte is this track stored public ulong TrackFileOffset; + /// What kind of file is storing this track public string TrackFileType; + /// How many main channel / user data bytes are per sector in this track public int TrackBytesPerSector; + /// How many main channel bytes per sector are in the file with this track public int TrackRawBytesPerSector; + /// Which file stores this track's subchannel public string TrackSubchannelFile; + /// Starting at which byte are this track's subchannel stored public ulong TrackSubchannelOffset; + /// Type of subchannel stored for this track public TrackSubchannelType TrackSubchannelType; } + /// + /// Type of subchannel in track + /// public enum TrackSubchannelType { + /// + /// Track does not has subchannel dumped, or it's not a CD + /// None, + /// + /// Subchannel is packed and error corrected + /// Packed, + /// + /// Subchannel is interleaved + /// Raw, + /// + /// Subchannel is packed and comes interleaved with main channel in same file + /// PackedInterleaved, + /// + /// Subchannel is interleaved and comes interleaved with main channel in same file + /// RawInterleaved } @@ -639,11 +665,26 @@ namespace DiscImageChef.ImagePlugins ATAPI_IDENTIFY }; + /// + /// Enumeration of media types defined in CICM metadata + /// public enum XmlMediaType { + /// + /// Purely optical discs + /// OpticalDisc, + /// + /// Media that is physically block-based or abstracted like that + /// BlockMedia, + /// + /// Media that can be accessed by-byte or by-bit, like chips + /// LinearMedia, + /// + /// Media that can only store data when it is modulated to audio + /// AudioMedia } diff --git a/DiscImageChef.Filesystems/ChangeLog b/DiscImageChef.Filesystems/ChangeLog index 97764bd1e..46c321c40 100644 --- a/DiscImageChef.Filesystems/ChangeLog +++ b/DiscImageChef.Filesystems/ChangeLog @@ -1,3 +1,8 @@ +2015-12-06 Natalia Portillo + + * Plugin.cs: + Added documentation. + 2015-12-06 Natalia Portillo * FFS.cs: diff --git a/DiscImageChef.Filesystems/Plugin.cs b/DiscImageChef.Filesystems/Plugin.cs index 1f793c7d3..a0cb62c6f 100644 --- a/DiscImageChef.Filesystems/Plugin.cs +++ b/DiscImageChef.Filesystems/Plugin.cs @@ -51,6 +51,10 @@ namespace DiscImageChef.Plugins public Guid PluginUUID; internal Schemas.FileSystemType xmlFSType; + /// + /// Information about the filesystem as expected by CICM Metadata XML + /// + /// Information about the filesystem as expected by CICM Metadata XML public Schemas.FileSystemType XmlFSType { get @@ -76,7 +80,8 @@ namespace DiscImageChef.Plugins /// Gets information about the identified filesystem. /// /// Disk image. - /// Partition offset (LBA). + /// Partition start sector (LBA). + /// Partition end sector (LBA). /// Filesystem information. public abstract void GetInformation(ImagePlugins.ImagePlugin imagePlugin, ulong partitionStart, ulong partitionEnd, out string information); }