[Feature] Update library documentation (#580)

* Minor IHardware doc fixes

* Add XML with documentation to NuGet and output

* Update Software namespace docs

* Update some internal classes

* Update main Computer class docs

* Update interfaces docs

* Update Computer class documentation

* Update motherboard docs

* Update hardware docs

* Fix code formatting

* Update SensorVisitor handler doc
This commit is contained in:
Pomian
2021-10-18 13:23:43 +02:00
committed by GitHub
parent 9df5a2de05
commit 3cf5fe92fd
17 changed files with 354 additions and 81 deletions
@@ -11,12 +11,28 @@ namespace LibreHardwareMonitor.Hardware
/// </summary>
public interface IVisitor
{
/// <summary>
/// Refreshes the values of all <see cref="ISensor"/> in all <see cref="IHardware"/> on selected <see cref="IComputer"/>.
/// </summary>
/// <param name="computer">Instance of the computer to be revisited.</param>
void VisitComputer(IComputer computer);
/// <summary>
/// Refreshes the values of all <see cref="ISensor"/> on selected <see cref="IHardware"/>.
/// </summary>
/// <param name="hardware">Instance of the hardware to be revisited.</param>
void VisitHardware(IHardware hardware);
/// <summary>
/// Refreshes the values on selected <see cref="ISensor"/>.
/// </summary>
/// <param name="sensor">Instance of the sensor to be revisited.</param>
void VisitSensor(ISensor sensor);
/// <summary>
/// Refreshes the values on selected <see cref="IParameter"/>.
/// </summary>
/// <param name="parameter">Instance of the parameter to be revisited.</param>
void VisitParameter(IParameter parameter);
}
}