Skip to content

Commit

Permalink
Adds descriptive code help. Minor changes
Browse files Browse the repository at this point in the history
  • Loading branch information
iAJTin committed Jul 31, 2020
1 parent 93d9aab commit 9eda4fa
Show file tree
Hide file tree
Showing 77 changed files with 3,153 additions and 2,929 deletions.
30 changes: 30 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,32 @@
# Changelog
All notable changes to this project will be documented in this file.

## [1.0.4] - 2020-07-31

### Fixed

- Fixed the bug reported by [@nk64](https://https://github.com/nk64), please see https://github.com/iAJTin/iEEDID/issues/1 for more information.

### Changed

- Minor changes.

- Adds descriptive code help. I Tried to adds a help most descriptive for the properties keys.

- The image below shows an example.

![Help.png][helpimg]

- Library versions for this version

|Library|Version|Description|
|:------|:------|:----------|
|iTin.Core| **1.0.2** | Common calls |
|iTin.Core.Interop| 1.0.0 | Interop calls |
|iTin.Core.Hardware| **1.0.1** | Hardware Interop Calls |
|iTin.Core.Hardware.Specification.Eedid|**1.0.4**| E-EDID Specification Implementation |


## [1.0.3] - 2019-09-02

### Added
Expand Down Expand Up @@ -68,7 +94,11 @@ All notable changes to this project will be documented in this file.
### Added
- Create project and first commit

[1.0.4]: https://github.com/iAJTin/iEEDID/releases/tag/v1.0.4
[1.0.3]: https://github.com/iAJTin/iEEDID/releases/tag/v1.0.3
[1.0.2]: https://github.com/iAJTin/iEEDID/releases/tag/v1.0.2
[1.0.1]: https://github.com/iAJTin/iEEDID/releases/tag/v1.0.1
[1.0.0]: https://github.com/iAJTin/iEEDID/releases/tag/v1.0.0

[helpimg]: ./assets/helpimg.png "help"

17 changes: 17 additions & 0 deletions README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,23 @@ What is iEEDID?

iEEDID is a lightweight implementation that allows us to obtain the the EEDID information.

Library versions
================

Library versions for current iEEDID version (1.0.4)

���������������������������������������������������������������������������������������������
| Library Version Description |
���������������������������������������������������������������������������������������������
|iTin.Core 1.0.2 Common calls |
���������������������������������������������������������������������������������������������
|iTin.Core.Interop 1.0.0 Interop calls |
���������������������������������������������������������������������������������������������
|iTin.Core.Hardware 1.0.1 Hardware Interop Calls |
���������������������������������������������������������������������������������������������
|iTin.Core.Hardware.Specification.Eedid 1.0.4 E-EDID Specification Implementation |
���������������������������������������������������������������������������������������������

Install via NuGet
=================

Expand Down
Binary file added assets/helpimg.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion nuget/BuildNuGet.bat
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
@ECHO OFF
CLS

..\src\.nuget\nuget Pack iEEDID.1.0.3.nuspec -NoDefaultExcludes -NoPackageAnalysis -OutputDirectory ..\deployment\nuget
..\src\.nuget\nuget Pack iEEDID.1.0.4.nuspec -NoDefaultExcludes -NoPackageAnalysis -OutputDirectory ..\deployment\nuget

pause

2 changes: 1 addition & 1 deletion nuget/iEEDID.1.0.3.nuspec → nuget/iEEDID.1.0.4.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<package xmlns="http://schemas.microsoft.com/packaging/2011/08/nuspec.xsd">
<metadata>
<id>iEEDID</id>
<version>1.0.3</version>
<version>1.0.4</version>
<title>iEEDID</title>
<authors>iAJTin</authors>
<owners>iAJTin</owners>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ namespace iTin.Core.Hardware.Specification
using Eedid;

/// <summary>
/// Implementation of the <strong>E-EDID</strong> (Extended Display Identification Data) specification.
/// Implementation of the <b>E-EDID</b> (Extended Display Identification Data) specification.
/// </summary>
public sealed class EEDID
{
Expand All @@ -32,7 +32,7 @@ public sealed class EEDID
/// </summary>
/// <param name="rawData">Data</param>
/// <remarks>
/// Returns the <strong>E-EDID</strong> information available.
/// Returns the <b>E-EDID</b> information available.
/// </remarks>
private EEDID(IEnumerable<byte> rawData)
{
Expand All @@ -50,7 +50,7 @@ private EEDID(IEnumerable<byte> rawData)
///// </summary>
///// <param name="monitor">Propiedad que representa la clave de registro del monitor.</param>
///// <remarks>
///// Obtiene la información <strong>E-EDID</strong> disponible.
///// Obtiene la información <b>E-EDID</b> disponible.
///// </remarks>
//public EEDID(Monitor monitor) : this(((TypedMonitorDeviceInfo)monitor.GetTypedDeviceData()).GetNativeDeviceData())
//{
Expand All @@ -63,7 +63,7 @@ private EEDID(IEnumerable<byte> rawData)
///// </summary>
///// <param name="monitorNativeData">Propiedad que representa la clave de registro del monitor.</param>
///// <remarks>
///// Obtiene la información <strong>E-EDID</strong> disponible.
///// Obtiene la información <b>E-EDID</b> disponible.
///// </remarks>
//internal EEDID(MonitorDeviceInfo monitorNativeData) : this(NativeDeviceManagement.GetEdidRawDataFromMonitor(monitorNativeData))
//{
Expand Down Expand Up @@ -95,7 +95,7 @@ private EEDID(IEnumerable<byte> rawData)
/// </summary>
/// <value>
/// Object <see cref="DataBlockCollection" /> that contains the object collection <see cref="DataBlock" /> for this <see cref="EEDID" />.
/// If there is no object <see cref="DataBlock" />, <strong>null</strong> is returned.
/// If there is no object <see cref="DataBlock" />, <b>null</b> is returned.
/// </value>
public DataBlockCollection Blocks
{
Expand All @@ -119,7 +119,7 @@ public DataBlockCollection Blocks
/// Gets a value that indicates if there are available blocks.
/// </summary>
/// <value>
/// <strong>true</strong> if there are blocks; otherwise, it is <strong>false</strong>.
/// <b>true</b> if there are blocks; otherwise, it is <b>false</b>.
/// </value>
public bool HasBlocks
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ namespace iTin.Core.Hardware.Specification.Eedid
// | · Checksum |
// •——————————————————————————————————————————————•

/// <inheritdoc />
/// <summary>
/// Specialization of the class <see cref="T:iTin.Core.Hardware.Specification.Eedid.BaseDataBlock" /> representing the block <see cref="F:iTin.Core.Hardware.Specification.Eedid.KnownDataBlock.CEA" /> of the specification <see cref="T:iTin.Core.Hardware.Specification.EEDID" />.
/// Specialization of the <see cref="BaseDataBlock"/> class.<br/>
/// Representing the block <see cref="KnownDataBlock.CEA"/> of the specification <see cref="EEDID"/>.
/// </summary>
internal class CeaBlock : BaseDataBlock
{
Expand All @@ -36,11 +36,11 @@ internal class CeaBlock : BaseDataBlock
#region [public] CeaBlock(ReadOnlyCollection<byte>): Initialize a new instance of the class with the data in this section untreated
/// <inheritdoc />
/// <summary>
/// Initialize a new instance of the <see cref="T:iTin.Core.Hardware.Specification.Eedid.CeaBlock"/> class with the data in this section untreated.
/// Initialize a new instance of the <see cref="CeaBlock"/> class with the data in this section untreated.
/// </summary>
/// <param name="dataBlock">Raw data of this block.</param>
/// <remarks>
/// Create a <see cref="F:iTin.Core.Hardware.Specification.Eedid.KnownDataBlock.CEA"/> block (block 0) which belongs to the <see cref="T:iTin.Core.Hardware.Specification.EEDID"/> specification.
/// Create a <see cref="KnownDataBlock.CEA"/> block (block 0) which belongs to the <see cref="EEDID"/> specification.
/// </remarks>
public CeaBlock(ReadOnlyCollection<byte> dataBlock) : base(dataBlock)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ namespace iTin.Core.Hardware.Specification.Eedid
using System.Diagnostics;

/// <summary>
/// Representa al conjunto de <strong>secciones</strong> disponibles para la información <see cref="KnownDataBlock.CEA"/> de la especificación <see cref="EEDID"/>.
/// Represents the set of <b>sections</b> available for the <see cref="KnownDataBlock.CEA"/> information of the <see cref="EEDID"/> specification.
/// </summary>
internal sealed class CeaSectionsInformation
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ namespace iTin.Core.Hardware.Specification.Eedid
// | 00h CheckSum BYTE Note: Please see, Status |
// •————————————————————————————————————————————————————————————————————————————————————————————————————————•

/// <inheritdoc />
/// <summary>
/// Especialización de la clase <see cref="T:iTin.Core.Hardware.Specification.Eedid.BaseDataSection" /> que representa la sección <see cref="F:iTin.Core.Hardware.Specification.Eedid.KnownCeaSection.CheckSum" /> de este bloque <see cref="F:iTin.Core.Hardware.Specification.Eedid.KnownDataBlock.CEA" />.
/// Specialization of the <see cref="BaseDataSection"/> class.<br/>
/// Represents the <see cref="KnownCeaSection.CheckSum"/> section of this block <see cref="KnownDataBlock.CEA"/>.
/// </summary>
internal sealed class CheckSumCeaSection : BaseDataSection
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,18 @@
namespace iTin.Core.Hardware.Specification.Eedid
{
using System;
using System.Collections;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Diagnostics.CodeAnalysis;
using System.Linq;

// CEA Section: Data Block Collection Information
// •————————————————————————————————————————————————————————————————————————————————————————————————————————•
// | Offset Name Lenght Description |
// •————————————————————————————————————————————————————————————————————————————————————————————————————————•

/// <inheritdoc />

/// <summary>
/// Especialización de la clase <see cref="T:iTin.Core.Hardware.Specification.Eedid.BaseDataSection" /> que representa la sección <see cref="F:iTin.Core.Hardware.Specification.Eedid.KnownCeaSection.DataBlockCollection" /> de este bloque <see cref="F:iTin.Core.Hardware.Specification.Eedid.KnownDataBlock.CEA" />.
/// Specialization of the <see cref="BaseDataSection"/> class.<br/>
/// Represents the <see cref="KnownCeaSection.DataBlockCollection"/> section of this block <see cref="KnownDataBlock.CEA"/>.
/// </summary>
internal sealed class DataBlockCollectionCeaSection : BaseDataSection
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ namespace iTin.Core.Hardware.Specification.Eedid
// | Offset Name Lenght Description |
// •————————————————————————————————————————————————————————————————————————————————————————————————————————•

/// <inheritdoc />
/// <summary>
/// Especialización de la clase <see cref="T:iTin.Core.Hardware.Specification.Eedid.BaseDataSection" /> que representa la sección <see cref="F:iTin.Core.Hardware.Specification.Eedid.KnownCeaSection.DetailedTiming" /> de este bloque <see cref="F:iTin.Core.Hardware.Specification.Eedid.KnownDataBlock.CEA" />.
/// Specialization of the <see cref="BaseDataSection"/> class.<br/>
/// Represents the <see cref="KnownCeaSection.DetailedTiming"/> section of this block <see cref="KnownDataBlock.CEA"/>.
/// </summary>
internal sealed class DetailedTimingsCeaSection : BaseDataSection
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ namespace iTin.Core.Hardware.Specification.Eedid
•————————————————• */

/// <summary>
/// Estructura <see cref="CeaDataBlock"/> que contiene la información sin procesar de los bloques de tipo <b>AllcationDataBlock</b>.
/// A <see cref = "CeaDataBlock"/> structure that contains the raw information of the blocks of type <b>AllcationDataBlock</b>.
/// </summary>
internal struct CeaDataBlock
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,32 +17,32 @@ namespace iTin.Core.Hardware.Specification.Eedid
•————————————————————————————————————————————————————————————————————————————• */

/// <summary>
/// Tipo de extensión de un Data Block de la extensión CEA
/// Type of extension of a Data Block of the CEA extension.
/// </summary>
internal enum KnownExtendedTag
{
/// <summary>
///
/// Video Capability
/// </summary>
VideoCapability = 0x00,

/// <summary>
///
/// Vendor Specific Video
/// </summary>
VendorSpecificVideo = 0x01,

/// <summary>
///
/// Colorimetry
/// </summary>
Colorimetry = 0x05,

/// <summary>
///
/// Miscellaneous Audio Fields
/// </summary>
MiscellaneousAudioFields = 0x10,

/// <summary>
///
/// Vendor Specific Audio
/// </summary>
VendorSpecificAudio = 0x11,
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
namespace iTin.Core.Hardware.Specification.Eedid
{
/// <summary>
/// Tipo de bloques de la extensión CEA
/// CEA Extension Block Type.
/// </summary>
internal enum KnownShortDataBlockTag
{
/// <summary>
///
/// Reserved
/// </summary>
Reserved = 0x00,

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ namespace iTin.Core.Hardware.Specification.Eedid
// | Note: Please see, Implemented |
// •————————————————————————————————————————————————————————————————————————————————————————————————————————•

/// <inheritdoc />
/// <summary>
/// Especialización de la clase <see cref="T:iTin.Core.Hardware.Specification.Eedid.BaseDataSection" /> que representa la sección <see cref="F:iTin.Core.Hardware.Specification.Eedid.KnownCeaSection.Information" /> de este bloque <see cref="F:iTin.Core.Hardware.Specification.Eedid.KnownDataBlock.CEA" />.
/// Specialization of the <see cref="BaseDataSection"/> class.<br/>
/// Represents the <see cref="KnownCeaSection.Information"/> section of this block <see cref="KnownDataBlock.CEA"/>.
/// </summary>
internal sealed class InformationCeaSection : BaseDataSection
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ namespace iTin.Core.Hardware.Specification.Eedid
// | included |
// •————————————————————————————————————————————————————————————————————————————————————————————————————————•

/// <inheritdoc />
/// <summary>
/// Especialización de la clase <see cref="T:iTin.Core.Hardware.Specification.Eedid.BaseDataSection" /> que representa la sección <see cref="F:iTin.Core.Hardware.Specification.Eedid.KnownCeaSection.MonitorSupport" /> de este bloque <see cref="F:iTin.Core.Hardware.Specification.Eedid.KnownDataBlock.CEA" />.
/// Specialization of the <see cref="BaseDataSection"/> class.<br/>
/// Represents the <see cref="KnownCeaSection.MonitorSupport"/> section of this block <see cref="KnownDataBlock.CEA"/>.
/// </summary>
internal sealed class MonitorSupportCeaSection : BaseDataSection
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ namespace iTin.Core.Hardware.Specification.Eedid
using Helpers.Enumerations;

/// <summary>
/// Estructura <see cref="AudioDataBlock"/> que contiene la lógica para decodificar los datos de un bloque del tipo <see cref="ShortAudioDescriptorCeaSection"/>.
/// Structure <see cref="AudioDataBlock"/> that contains the logic to decode the data of a block of type <see cref="ShortAudioDescriptorCeaSection"/>.
/// </summary>
internal struct AudioDataBlock
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ namespace iTin.Core.Hardware.Specification.Eedid
using Helpers.Enumerations;

/// <summary>
/// Estructura <see cref="ColorimetryDataBlock"/> que contiene la lógica para decodificar los datos de un bloque del tipo <see cref="KnownExtendedTag.Colorimetry"/>.
/// Structure <see cref="ColorimetryDataBlock"/> that contains the logic to decode the data of a block of type <see cref="KnownExtendedTag.Colorimetry"/>.
/// </summary>
internal struct ColorimetryDataBlock
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ namespace iTin.Core.Hardware.Specification.Eedid
•—————————————————————————————————————————————• */

/// <summary>
/// Códigos de formatos de audio disponibles para el tipo <see cref="AudioDataBlock"/>.
/// Audio format codes available for type <see cref="AudioDataBlock"/>.
/// </summary>
internal enum KnownAudioFormatCode
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ namespace iTin.Core.Hardware.Specification.Eedid
using System.Collections.ObjectModel;

/// <summary>
/// Estructura <see cref="ReservedDataBlock"/> que contiene la lógica para decodificar los datos de un bloque del tipo <see cref="ShortReservedDescriptorCeaSection"/>.
/// Structure <see cref="ReservedDataBlock"/> that contains the logic to decode the data of a block of type <see cref="ShortReservedDescriptorCeaSection"/>.
/// </summary>
internal struct ReservedDataBlock
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ namespace iTin.Core.Hardware.Specification.Eedid
using Helpers.Enumerations;

/// <summary>
/// Estructura <see cref="SpeakerDataBlock"/> que contiene la lógica para decodificar los datos de un bloque del tipo <see cref="ShortSpeakerDescriptorCeaSection"/>.
/// Structure <see cref="SpeakerDataBlock"/> that contains the logic to decode the data of a block of type <see cref="ShortSpeakerDescriptorCeaSection"/>.
/// </summary>
internal struct SpeakerDataBlock
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ namespace iTin.Core.Hardware.Specification.Eedid
using Helpers.Enumerations;

/// <summary>
/// Estructura <see cref="VideoCapabilityDataBlock"/> que contiene la lógica para decodificar los datos de un bloque del tipo <see cref="KnownExtendedTag.VideoCapability"/>.
/// Structure <see cref="VideoCapabilityDataBlock"/> that contains the logic to decode the data of a block of type <see cref="KnownExtendedTag.VideoCapability"/>.
/// </summary>
internal struct VideoCapabilityDataBlock
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ namespace iTin.Core.Hardware.Specification.Eedid
using Helpers.Enumerations;

/// <summary>
/// Estructura <see cref="VideoDataBlock"/> que contiene la lógica para decodificar los datos de un bloque del tipo <see cref="ShortVideoDescriptorCeaSection"/>.
/// Structure <see cref="VideoDataBlock"/> that contains the logic to decode the data of a block of type <see cref="ShortVideoDescriptorCeaSection"/>.
/// </summary>
internal struct VideoDataBlock
{
Expand Down
Loading

0 comments on commit 9eda4fa

Please sign in to comment.