Documentation modifications
This commit is contained in:
@@ -6,10 +6,20 @@
|
||||
/// <typeparam name="T">The type of the response payload.</typeparam>
|
||||
public class UciResponse<T>
|
||||
{
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="UciResponse"/> class with default values.
|
||||
/// This protected parameterless constructor enables the <see cref="UciResponse"/> type to be instantiated by derived classes.
|
||||
/// </summary>
|
||||
/// <!-- aidoc:v1 sig=bc935a2 body=4448e1d -->
|
||||
protected UciResponse()
|
||||
{
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a successful instance of the <see cref="UciResponse{T}"/> class, which wraps an entity as a response payload. The constructor assigns <paramref name="entity"/> to <see cref="UciResponse{T}.Data"/>, sets <see cref="UciResponse{T}.Success"/> to <c>true</c>, and clears <see cref="UciResponse{T}.Message"/> and <see cref="UciResponse{T}.Error"/>.
|
||||
/// </summary>
|
||||
/// <param name="entity">The payload to encapsulate in the response, stored in the <see cref="UciResponse{T}.Data"/> property.</param>
|
||||
/// <!-- aidoc:v1 sig=5205995 body=dd7f9e7 -->
|
||||
protected UciResponse(T entity)
|
||||
{
|
||||
Success = true;
|
||||
|
||||
Reference in New Issue
Block a user