From 98290c7b28f7dd8b139e8b9a5bfe26f5dada9e35 Mon Sep 17 00:00:00 2001 From: Developer 02 Date: Thu, 10 Apr 2025 18:42:51 +0200 Subject: [PATCH] Update comments in ReadEnvelopeReceiverResponse.cs Enhanced clarity and detail in class documentation. Rephrased summaries and remarks for better understanding of the class and its properties, including the relationship between envelope and receiver. Clarified parameters `UserId` and `Status` for improved overall documentation. --- .../Read/ReadEnvelopeReceiverResponse.cs | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/EnvelopeGenerator.Application/EnvelopeReceivers/Queries/Read/ReadEnvelopeReceiverResponse.cs b/EnvelopeGenerator.Application/EnvelopeReceivers/Queries/Read/ReadEnvelopeReceiverResponse.cs index ca0526be..dd9c482b 100644 --- a/EnvelopeGenerator.Application/EnvelopeReceivers/Queries/Read/ReadEnvelopeReceiverResponse.cs +++ b/EnvelopeGenerator.Application/EnvelopeReceivers/Queries/Read/ReadEnvelopeReceiverResponse.cs @@ -7,20 +7,23 @@ using System.ComponentModel.DataAnnotations.Schema; namespace EnvelopeGenerator.Application.EnvelopeReceivers.Queries.Read; /// -/// Stellt eine Antwort auf die Abfrage zum Lesen eines Envelope-Empfängers dar. +/// Repräsentiert die Antwort für das Lesen eines Envelope-Empfängers. /// -/// Der angeforderte Empfänger. +/// +/// Diese Klasse enthält Informationen über einen spezifischen Empfänger eines Umschlags (Envelope). +/// Sie verknüpft die Empfängerinformationen mit den zugehörigen Umschlagsdaten und bietet zusätzliche Metadaten. +/// +/// Die eindeutige Kennung des Benutzers, der den Empfänger erstellt hat. +/// Der Status des Empfängers als numerischer Wert. public record ReadEnvelopeReceiverResponse(int UserId, int Status) { /// - /// Repräsentiert die Antwort für das Lesen eines Envelope-Empfängers. + /// Gibt die zusammengesetzte Kennung des Empfängers zurück, bestehend aus der Umschlags-ID und der Empfänger-ID. /// /// - /// Diese Klasse enthält Informationen über einen spezifischen Empfänger eines Umschlags (Envelope). - /// Sie verknüpft die Empfängerinformationen mit den zugehörigen Umschlagsdaten und bietet zusätzliche Metadaten. + /// Diese Eigenschaft kombiniert die eindeutige Kennung des Umschlags (EnvelopeId) und die des Empfängers (ReceiverId) + /// zu einer einzigen, leicht zugänglichen Struktur. /// - /// Die eindeutige Kennung des Benutzers, der den Empfänger erstellt hat. - /// Der Status des Empfängers als numerischer Wert. [NotMapped] public (int Envelope, int Receiver) Id => (Envelope: EnvelopeId, Receiver: ReceiverId);