diff --git a/SafeExamBrowser.Contracts/Behaviour/IApplicationController.cs b/SafeExamBrowser.Contracts/Behaviour/IApplicationController.cs index e8c35df2..b6407a79 100644 --- a/SafeExamBrowser.Contracts/Behaviour/IApplicationController.cs +++ b/SafeExamBrowser.Contracts/Behaviour/IApplicationController.cs @@ -11,7 +11,7 @@ using SafeExamBrowser.Contracts.UserInterface.Taskbar; namespace SafeExamBrowser.Contracts.Behaviour { /// - /// Controls the lifetime and functionality of a (third-party) application which can be accessed via the taskbar. + /// Controls the lifetime and functionality of a (third-party) application which can be accessed via the . /// public interface IApplicationController { diff --git a/SafeExamBrowser.Contracts/Behaviour/IClientController.cs b/SafeExamBrowser.Contracts/Behaviour/IClientController.cs index f2d6b5a4..ee6e7309 100644 --- a/SafeExamBrowser.Contracts/Behaviour/IClientController.cs +++ b/SafeExamBrowser.Contracts/Behaviour/IClientController.cs @@ -13,6 +13,9 @@ using SafeExamBrowser.Contracts.Configuration.Settings; namespace SafeExamBrowser.Contracts.Behaviour { + /// + /// Controls the lifetime and is responsible for the event handling of the client application component. + /// public interface IClientController { /// diff --git a/SafeExamBrowser.Contracts/Behaviour/INotificationController.cs b/SafeExamBrowser.Contracts/Behaviour/INotificationController.cs index a668f99d..14bae7d6 100644 --- a/SafeExamBrowser.Contracts/Behaviour/INotificationController.cs +++ b/SafeExamBrowser.Contracts/Behaviour/INotificationController.cs @@ -6,11 +6,13 @@ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ -using SafeExamBrowser.Contracts.UserInterface; using SafeExamBrowser.Contracts.UserInterface.Taskbar; namespace SafeExamBrowser.Contracts.Behaviour { + /// + /// Controls the lifetime and functionality of a notification which is part of the . + /// public interface INotificationController { /// diff --git a/SafeExamBrowser.Contracts/Behaviour/IRuntimeController.cs b/SafeExamBrowser.Contracts/Behaviour/IRuntimeController.cs index e40a3518..5da7352d 100644 --- a/SafeExamBrowser.Contracts/Behaviour/IRuntimeController.cs +++ b/SafeExamBrowser.Contracts/Behaviour/IRuntimeController.cs @@ -8,6 +8,9 @@ namespace SafeExamBrowser.Contracts.Behaviour { + /// + /// Controls the lifetime and is responsible for the event handling of the runtime application component. + /// public interface IRuntimeController { /// diff --git a/SafeExamBrowser.Contracts/Behaviour/Operations/IOperation.cs b/SafeExamBrowser.Contracts/Behaviour/Operations/IOperation.cs index 2e71b44c..1b38a9c3 100644 --- a/SafeExamBrowser.Contracts/Behaviour/Operations/IOperation.cs +++ b/SafeExamBrowser.Contracts/Behaviour/Operations/IOperation.cs @@ -10,6 +10,9 @@ using SafeExamBrowser.Contracts.UserInterface; namespace SafeExamBrowser.Contracts.Behaviour.Operations { + /// + /// Defines an operation which will be executed as part of an . + /// public interface IOperation { /// diff --git a/SafeExamBrowser.Contracts/Behaviour/Operations/IOperationSequence.cs b/SafeExamBrowser.Contracts/Behaviour/Operations/IOperationSequence.cs index 26945ef8..b3d18c52 100644 --- a/SafeExamBrowser.Contracts/Behaviour/Operations/IOperationSequence.cs +++ b/SafeExamBrowser.Contracts/Behaviour/Operations/IOperationSequence.cs @@ -10,6 +10,17 @@ using SafeExamBrowser.Contracts.UserInterface; namespace SafeExamBrowser.Contracts.Behaviour.Operations { + /// + /// A sequence of s which can be used for sequential procedures, e.g. the initialization & finalization of an + /// application component. Each operation will be executed failsafe, i.e. the return value will indicate whether a procedure completed + /// successfully or not. + /// + /// The execution order of the individual operations (for an exemplary sequence initialized with operations A, B, C, D) is as follows: + /// + /// : The operations will be performed according to their initialized order (A -> B -> C -> D). + /// : The operations will be repeated according to their initialized order (A -> B -> C -> D). + /// : The operations will be reverted according to the reversed initial order (D -> C -> B -> A). + /// public interface IOperationSequence { /// diff --git a/SafeExamBrowser.Contracts/Behaviour/Operations/OperationResult.cs b/SafeExamBrowser.Contracts/Behaviour/Operations/OperationResult.cs index 6036fbd1..9276d3ac 100644 --- a/SafeExamBrowser.Contracts/Behaviour/Operations/OperationResult.cs +++ b/SafeExamBrowser.Contracts/Behaviour/Operations/OperationResult.cs @@ -8,6 +8,9 @@ namespace SafeExamBrowser.Contracts.Behaviour.Operations { + /// + /// Defines the result of the sequential execution of s (as part of an ). + /// public enum OperationResult { /// diff --git a/SafeExamBrowser.Contracts/Communication/IClientHost.cs b/SafeExamBrowser.Contracts/Communication/IClientHost.cs index 4e7b7e7f..1c0b6c5c 100644 --- a/SafeExamBrowser.Contracts/Communication/IClientHost.cs +++ b/SafeExamBrowser.Contracts/Communication/IClientHost.cs @@ -10,6 +10,9 @@ using System; namespace SafeExamBrowser.Contracts.Communication { + /// + /// Defines the functionality of the communication host for the client application component. + /// public interface IClientHost : ICommunicationHost { /// diff --git a/SafeExamBrowser.Contracts/Communication/IClientProxy.cs b/SafeExamBrowser.Contracts/Communication/IClientProxy.cs index 7fdca40d..1ac93133 100644 --- a/SafeExamBrowser.Contracts/Communication/IClientProxy.cs +++ b/SafeExamBrowser.Contracts/Communication/IClientProxy.cs @@ -10,6 +10,9 @@ using SafeExamBrowser.Contracts.Communication.Responses; namespace SafeExamBrowser.Contracts.Communication { + /// + /// Defines the functionality for a proxy to the communication host of the client application component. + /// public interface IClientProxy : ICommunicationProxy { /// diff --git a/SafeExamBrowser.Contracts/Communication/ICommunication.cs b/SafeExamBrowser.Contracts/Communication/ICommunication.cs index 14d1816f..9bab6eb5 100644 --- a/SafeExamBrowser.Contracts/Communication/ICommunication.cs +++ b/SafeExamBrowser.Contracts/Communication/ICommunication.cs @@ -14,6 +14,9 @@ using SafeExamBrowser.Contracts.Configuration; namespace SafeExamBrowser.Contracts.Communication { + /// + /// Defines the API for all communication between the three application components (runtime, service and client). + /// [ServiceContract(SessionMode = SessionMode.Required)] [ServiceKnownType(typeof(SimpleMessage))] [ServiceKnownType(typeof(AuthenticationResponse))] diff --git a/SafeExamBrowser.Contracts/Communication/ICommunicationHost.cs b/SafeExamBrowser.Contracts/Communication/ICommunicationHost.cs index 7b05f063..2393248f 100644 --- a/SafeExamBrowser.Contracts/Communication/ICommunicationHost.cs +++ b/SafeExamBrowser.Contracts/Communication/ICommunicationHost.cs @@ -10,6 +10,9 @@ namespace SafeExamBrowser.Contracts.Communication { public delegate void CommunicationEventHandler(); + /// + /// Defines the common functionality for all communication hosts. + /// public interface ICommunicationHost { /// diff --git a/SafeExamBrowser.Contracts/Communication/ICommunicationProxy.cs b/SafeExamBrowser.Contracts/Communication/ICommunicationProxy.cs index 58484637..ceab8a46 100644 --- a/SafeExamBrowser.Contracts/Communication/ICommunicationProxy.cs +++ b/SafeExamBrowser.Contracts/Communication/ICommunicationProxy.cs @@ -10,6 +10,9 @@ using System; namespace SafeExamBrowser.Contracts.Communication { + /// + /// Defines the common functionality for all communication proxies. + /// public interface ICommunicationProxy { /// diff --git a/SafeExamBrowser.Contracts/Communication/IRuntimeHost.cs b/SafeExamBrowser.Contracts/Communication/IRuntimeHost.cs index 6aa636f9..49610487 100644 --- a/SafeExamBrowser.Contracts/Communication/IRuntimeHost.cs +++ b/SafeExamBrowser.Contracts/Communication/IRuntimeHost.cs @@ -10,6 +10,9 @@ using System; namespace SafeExamBrowser.Contracts.Communication { + /// + /// Defines the functionality of the communication host for the runtime application component. + /// public interface IRuntimeHost : ICommunicationHost { /// diff --git a/SafeExamBrowser.Contracts/Communication/IRuntimeProxy.cs b/SafeExamBrowser.Contracts/Communication/IRuntimeProxy.cs index 0ab70170..5b5ba4a9 100644 --- a/SafeExamBrowser.Contracts/Communication/IRuntimeProxy.cs +++ b/SafeExamBrowser.Contracts/Communication/IRuntimeProxy.cs @@ -10,6 +10,9 @@ using SafeExamBrowser.Contracts.Configuration; namespace SafeExamBrowser.Contracts.Communication { + /// + /// Defines the functionality for a proxy to the communication host of the runtime application component. + /// public interface IRuntimeProxy : ICommunicationProxy { /// diff --git a/SafeExamBrowser.Contracts/Communication/IServiceProxy.cs b/SafeExamBrowser.Contracts/Communication/IServiceProxy.cs index 06ef26e7..1b4d13b1 100644 --- a/SafeExamBrowser.Contracts/Communication/IServiceProxy.cs +++ b/SafeExamBrowser.Contracts/Communication/IServiceProxy.cs @@ -11,6 +11,9 @@ using SafeExamBrowser.Contracts.Configuration.Settings; namespace SafeExamBrowser.Contracts.Communication { + /// + /// Defines the functionality for a proxy to the communication host of the service application component. + /// public interface IServiceProxy : ICommunicationProxy { /// diff --git a/SafeExamBrowser.Contracts/Communication/Messages/DisconnectionMessage.cs b/SafeExamBrowser.Contracts/Communication/Messages/DisconnectionMessage.cs index ff4955b5..759e6db8 100644 --- a/SafeExamBrowser.Contracts/Communication/Messages/DisconnectionMessage.cs +++ b/SafeExamBrowser.Contracts/Communication/Messages/DisconnectionMessage.cs @@ -10,6 +10,9 @@ using System; namespace SafeExamBrowser.Contracts.Communication.Messages { + /// + /// This is the last message transmitted from a component to its interlocutor in order to terminate a communication session. + /// [Serializable] public class DisconnectionMessage : Message { diff --git a/SafeExamBrowser.Contracts/Communication/Messages/Message.cs b/SafeExamBrowser.Contracts/Communication/Messages/Message.cs index caa850ae..13a11b75 100644 --- a/SafeExamBrowser.Contracts/Communication/Messages/Message.cs +++ b/SafeExamBrowser.Contracts/Communication/Messages/Message.cs @@ -10,6 +10,9 @@ using System; namespace SafeExamBrowser.Contracts.Communication.Messages { + /// + /// The base class for messages, from which a message must inherit in order to be sent to an interlocutor via . + /// [Serializable] public abstract class Message { diff --git a/SafeExamBrowser.Contracts/Communication/Messages/SimpleMessage.cs b/SafeExamBrowser.Contracts/Communication/Messages/SimpleMessage.cs index 9a07c93e..9ad5313e 100644 --- a/SafeExamBrowser.Contracts/Communication/Messages/SimpleMessage.cs +++ b/SafeExamBrowser.Contracts/Communication/Messages/SimpleMessage.cs @@ -10,6 +10,9 @@ using System; namespace SafeExamBrowser.Contracts.Communication.Messages { + /// + /// A generic message to send simple purports without data to an interlocutor. + /// [Serializable] public class SimpleMessage : Message { diff --git a/SafeExamBrowser.Contracts/Communication/Messages/SimpleMessagePurport.cs b/SafeExamBrowser.Contracts/Communication/Messages/SimpleMessagePurport.cs index e6f1d3f5..2a6a604c 100644 --- a/SafeExamBrowser.Contracts/Communication/Messages/SimpleMessagePurport.cs +++ b/SafeExamBrowser.Contracts/Communication/Messages/SimpleMessagePurport.cs @@ -10,6 +10,9 @@ using System; namespace SafeExamBrowser.Contracts.Communication.Messages { + /// + /// The possible purports of a . + /// [Serializable] public enum SimpleMessagePurport { diff --git a/SafeExamBrowser.Contracts/Communication/Responses/AuthenticationResponse.cs b/SafeExamBrowser.Contracts/Communication/Responses/AuthenticationResponse.cs index 2a3115dc..c8cf7d79 100644 --- a/SafeExamBrowser.Contracts/Communication/Responses/AuthenticationResponse.cs +++ b/SafeExamBrowser.Contracts/Communication/Responses/AuthenticationResponse.cs @@ -10,6 +10,9 @@ using System; namespace SafeExamBrowser.Contracts.Communication.Responses { + /// + /// The response to be used to reply to an authentication request (see ). + /// [Serializable] public class AuthenticationResponse : Response { diff --git a/SafeExamBrowser.Contracts/Communication/Responses/ConfigurationResponse.cs b/SafeExamBrowser.Contracts/Communication/Responses/ConfigurationResponse.cs index d8d996a5..91b760b8 100644 --- a/SafeExamBrowser.Contracts/Communication/Responses/ConfigurationResponse.cs +++ b/SafeExamBrowser.Contracts/Communication/Responses/ConfigurationResponse.cs @@ -11,6 +11,9 @@ using SafeExamBrowser.Contracts.Configuration; namespace SafeExamBrowser.Contracts.Communication.Responses { + /// + /// The response to be used to reply to a configuration request (see ). + /// [Serializable] public class ConfigurationResponse : Response { diff --git a/SafeExamBrowser.Contracts/Communication/Responses/ConnectionResponse.cs b/SafeExamBrowser.Contracts/Communication/Responses/ConnectionResponse.cs index 61ddb965..20f35f27 100644 --- a/SafeExamBrowser.Contracts/Communication/Responses/ConnectionResponse.cs +++ b/SafeExamBrowser.Contracts/Communication/Responses/ConnectionResponse.cs @@ -10,6 +10,9 @@ using System; namespace SafeExamBrowser.Contracts.Communication.Responses { + /// + /// The response to a connection request (see ). + /// [Serializable] public class ConnectionResponse : Response { diff --git a/SafeExamBrowser.Contracts/Communication/Responses/DisconnectionResponse.cs b/SafeExamBrowser.Contracts/Communication/Responses/DisconnectionResponse.cs index ac432f35..04b39952 100644 --- a/SafeExamBrowser.Contracts/Communication/Responses/DisconnectionResponse.cs +++ b/SafeExamBrowser.Contracts/Communication/Responses/DisconnectionResponse.cs @@ -10,6 +10,9 @@ using System; namespace SafeExamBrowser.Contracts.Communication.Responses { + /// + /// The response transmitted to a + /// [Serializable] public class DisconnectionResponse : Response { diff --git a/SafeExamBrowser.Contracts/Communication/Responses/Response.cs b/SafeExamBrowser.Contracts/Communication/Responses/Response.cs index 0c91d224..3b202b8e 100644 --- a/SafeExamBrowser.Contracts/Communication/Responses/Response.cs +++ b/SafeExamBrowser.Contracts/Communication/Responses/Response.cs @@ -10,6 +10,9 @@ using System; namespace SafeExamBrowser.Contracts.Communication.Responses { + /// + /// The base class for respones, from which a response must inherit in order to be sent to an interlocutor as reply to . + /// [Serializable] public abstract class Response { diff --git a/SafeExamBrowser.Contracts/Communication/Responses/SimpleResponse.cs b/SafeExamBrowser.Contracts/Communication/Responses/SimpleResponse.cs index cc87c733..a33a431a 100644 --- a/SafeExamBrowser.Contracts/Communication/Responses/SimpleResponse.cs +++ b/SafeExamBrowser.Contracts/Communication/Responses/SimpleResponse.cs @@ -10,6 +10,9 @@ using System; namespace SafeExamBrowser.Contracts.Communication.Responses { + /// + /// A generic response to reply simple purports without data to an interlocutor. + /// [Serializable] public class SimpleResponse : Response { diff --git a/SafeExamBrowser.Contracts/Communication/Responses/SimpleResponsePurport.cs b/SafeExamBrowser.Contracts/Communication/Responses/SimpleResponsePurport.cs index ef869fe8..91226141 100644 --- a/SafeExamBrowser.Contracts/Communication/Responses/SimpleResponsePurport.cs +++ b/SafeExamBrowser.Contracts/Communication/Responses/SimpleResponsePurport.cs @@ -10,6 +10,9 @@ using System; namespace SafeExamBrowser.Contracts.Communication.Responses { + /// + /// The possible purports of a . + /// [Serializable] public enum SimpleResponsePurport { diff --git a/SafeExamBrowser.Contracts/Configuration/ClientConfiguration.cs b/SafeExamBrowser.Contracts/Configuration/ClientConfiguration.cs index 06340e03..02fe277e 100644 --- a/SafeExamBrowser.Contracts/Configuration/ClientConfiguration.cs +++ b/SafeExamBrowser.Contracts/Configuration/ClientConfiguration.cs @@ -10,6 +10,9 @@ using System; namespace SafeExamBrowser.Contracts.Configuration { + /// + /// Container for the configuration of the client application component. + /// [Serializable] public class ClientConfiguration { diff --git a/SafeExamBrowser.Contracts/Configuration/IApplicationInfo.cs b/SafeExamBrowser.Contracts/Configuration/IApplicationInfo.cs index c8c99008..f188d044 100644 --- a/SafeExamBrowser.Contracts/Configuration/IApplicationInfo.cs +++ b/SafeExamBrowser.Contracts/Configuration/IApplicationInfo.cs @@ -8,6 +8,9 @@ namespace SafeExamBrowser.Contracts.Configuration { + /// + /// The information about a (third-party) application which can be accessed via the . + /// public interface IApplicationInfo { /// diff --git a/SafeExamBrowser.Contracts/Configuration/IApplicationInstance.cs b/SafeExamBrowser.Contracts/Configuration/IApplicationInstance.cs index c3dc84f2..bef8a4e8 100644 --- a/SafeExamBrowser.Contracts/Configuration/IApplicationInstance.cs +++ b/SafeExamBrowser.Contracts/Configuration/IApplicationInstance.cs @@ -14,6 +14,9 @@ namespace SafeExamBrowser.Contracts.Configuration public delegate void TerminatedEventHandler(Guid id); public delegate void NameChangedEventHandler(string name); + /// + /// Defines an instance of a (third-party) application which can be accessed via the . + /// public interface IApplicationInstance { /// diff --git a/SafeExamBrowser.Contracts/Configuration/IConfigurationRepository.cs b/SafeExamBrowser.Contracts/Configuration/IConfigurationRepository.cs index 39db57df..78bec895 100644 --- a/SafeExamBrowser.Contracts/Configuration/IConfigurationRepository.cs +++ b/SafeExamBrowser.Contracts/Configuration/IConfigurationRepository.cs @@ -7,10 +7,12 @@ */ using System; -using SafeExamBrowser.Contracts.Configuration.Settings; namespace SafeExamBrowser.Contracts.Configuration { + /// + /// The repository which controls the loading and initializing of configuration data. + /// public interface IConfigurationRepository { /// diff --git a/SafeExamBrowser.Contracts/Configuration/IIconResource.cs b/SafeExamBrowser.Contracts/Configuration/IIconResource.cs index d295cfb9..40499f13 100644 --- a/SafeExamBrowser.Contracts/Configuration/IIconResource.cs +++ b/SafeExamBrowser.Contracts/Configuration/IIconResource.cs @@ -10,10 +10,13 @@ using System; namespace SafeExamBrowser.Contracts.Configuration { + /// + /// Defines an icon resource, i.e. the path to and type of an icon. + /// public interface IIconResource { /// - /// The Uri pointing to the icon. + /// The pointing to the icon. /// Uri Uri { get; } diff --git a/SafeExamBrowser.Contracts/Configuration/INotificationInfo.cs b/SafeExamBrowser.Contracts/Configuration/INotificationInfo.cs index ec4bedc7..6a01eb8b 100644 --- a/SafeExamBrowser.Contracts/Configuration/INotificationInfo.cs +++ b/SafeExamBrowser.Contracts/Configuration/INotificationInfo.cs @@ -8,6 +8,9 @@ namespace SafeExamBrowser.Contracts.Configuration { + /// + /// The information about a notification which is part of the . + /// public interface INotificationInfo { /// diff --git a/SafeExamBrowser.Contracts/Configuration/ISession.cs b/SafeExamBrowser.Contracts/Configuration/ISession.cs index 82460791..f14ae60c 100644 --- a/SafeExamBrowser.Contracts/Configuration/ISession.cs +++ b/SafeExamBrowser.Contracts/Configuration/ISession.cs @@ -11,6 +11,9 @@ using SafeExamBrowser.Contracts.WindowsApi; namespace SafeExamBrowser.Contracts.Configuration { + /// + /// Defines all session-related (configuration) data. + /// public interface ISession { /// diff --git a/SafeExamBrowser.Contracts/Configuration/ISystemInfo.cs b/SafeExamBrowser.Contracts/Configuration/ISystemInfo.cs index c92828cc..4323d3d5 100644 --- a/SafeExamBrowser.Contracts/Configuration/ISystemInfo.cs +++ b/SafeExamBrowser.Contracts/Configuration/ISystemInfo.cs @@ -8,6 +8,9 @@ namespace SafeExamBrowser.Contracts.Configuration { + /// + /// Provides access to information about the operating system. + /// public interface ISystemInfo { /// diff --git a/SafeExamBrowser.Contracts/Configuration/OperatingSystem.cs b/SafeExamBrowser.Contracts/Configuration/OperatingSystem.cs index 1530a5cc..7360d77d 100644 --- a/SafeExamBrowser.Contracts/Configuration/OperatingSystem.cs +++ b/SafeExamBrowser.Contracts/Configuration/OperatingSystem.cs @@ -8,6 +8,9 @@ namespace SafeExamBrowser.Contracts.Configuration { + /// + /// Defines all operating systems supported by the application. + /// public enum OperatingSystem { Unknown = 0, diff --git a/SafeExamBrowser.Contracts/Configuration/RuntimeInfo.cs b/SafeExamBrowser.Contracts/Configuration/RuntimeInfo.cs index 9487459b..f61985df 100644 --- a/SafeExamBrowser.Contracts/Configuration/RuntimeInfo.cs +++ b/SafeExamBrowser.Contracts/Configuration/RuntimeInfo.cs @@ -10,6 +10,9 @@ using System; namespace SafeExamBrowser.Contracts.Configuration { + /// + /// Defines the fundamental, global configuration information for all application components. + /// [Serializable] public class RuntimeInfo { diff --git a/SafeExamBrowser.Contracts/Configuration/Settings/BrowserSettings.cs b/SafeExamBrowser.Contracts/Configuration/Settings/BrowserSettings.cs index 663dccb2..393e1762 100644 --- a/SafeExamBrowser.Contracts/Configuration/Settings/BrowserSettings.cs +++ b/SafeExamBrowser.Contracts/Configuration/Settings/BrowserSettings.cs @@ -10,6 +10,9 @@ using System; namespace SafeExamBrowser.Contracts.Configuration.Settings { + /// + /// Defines all configuration options for the browser of the application. + /// [Serializable] public class BrowserSettings { diff --git a/SafeExamBrowser.Contracts/Configuration/Settings/ConfigurationMode.cs b/SafeExamBrowser.Contracts/Configuration/Settings/ConfigurationMode.cs index 53419abc..2d8e83f7 100644 --- a/SafeExamBrowser.Contracts/Configuration/Settings/ConfigurationMode.cs +++ b/SafeExamBrowser.Contracts/Configuration/Settings/ConfigurationMode.cs @@ -8,6 +8,9 @@ namespace SafeExamBrowser.Contracts.Configuration.Settings { + /// + /// Defines all possible configuration modes for the application. + /// public enum ConfigurationMode { /// diff --git a/SafeExamBrowser.Contracts/Configuration/Settings/KeyboardSettings.cs b/SafeExamBrowser.Contracts/Configuration/Settings/KeyboardSettings.cs index e653936d..2c3c6eaf 100644 --- a/SafeExamBrowser.Contracts/Configuration/Settings/KeyboardSettings.cs +++ b/SafeExamBrowser.Contracts/Configuration/Settings/KeyboardSettings.cs @@ -10,6 +10,9 @@ using System; namespace SafeExamBrowser.Contracts.Configuration.Settings { + /// + /// Defines all configuration options for the . + /// [Serializable] public class KeyboardSettings { diff --git a/SafeExamBrowser.Contracts/Configuration/Settings/KioskMode.cs b/SafeExamBrowser.Contracts/Configuration/Settings/KioskMode.cs index 5c3da31c..fae45596 100644 --- a/SafeExamBrowser.Contracts/Configuration/Settings/KioskMode.cs +++ b/SafeExamBrowser.Contracts/Configuration/Settings/KioskMode.cs @@ -8,6 +8,9 @@ namespace SafeExamBrowser.Contracts.Configuration.Settings { + /// + /// Defines all possible kiosk modes which the application supports. + /// public enum KioskMode { /// diff --git a/SafeExamBrowser.Contracts/Configuration/Settings/MouseSettings.cs b/SafeExamBrowser.Contracts/Configuration/Settings/MouseSettings.cs index 38fe176b..91598411 100644 --- a/SafeExamBrowser.Contracts/Configuration/Settings/MouseSettings.cs +++ b/SafeExamBrowser.Contracts/Configuration/Settings/MouseSettings.cs @@ -10,6 +10,9 @@ using System; namespace SafeExamBrowser.Contracts.Configuration.Settings { + /// + /// Defines all configuration options for the . + /// [Serializable] public class MouseSettings { diff --git a/SafeExamBrowser.Contracts/Configuration/Settings/ServicePolicy.cs b/SafeExamBrowser.Contracts/Configuration/Settings/ServicePolicy.cs index 4eba42ae..5fdd641f 100644 --- a/SafeExamBrowser.Contracts/Configuration/Settings/ServicePolicy.cs +++ b/SafeExamBrowser.Contracts/Configuration/Settings/ServicePolicy.cs @@ -8,6 +8,9 @@ namespace SafeExamBrowser.Contracts.Configuration.Settings { + /// + /// Defines all possible service policies which the application supports. + /// public enum ServicePolicy { /// diff --git a/SafeExamBrowser.Contracts/Configuration/Settings/Settings.cs b/SafeExamBrowser.Contracts/Configuration/Settings/Settings.cs index 83178b3c..f6d00873 100644 --- a/SafeExamBrowser.Contracts/Configuration/Settings/Settings.cs +++ b/SafeExamBrowser.Contracts/Configuration/Settings/Settings.cs @@ -10,6 +10,9 @@ using System; namespace SafeExamBrowser.Contracts.Configuration.Settings { + /// + /// Defines all configuration options for the application. + /// [Serializable] public class Settings { diff --git a/SafeExamBrowser.Contracts/Configuration/Settings/TaskbarSettings.cs b/SafeExamBrowser.Contracts/Configuration/Settings/TaskbarSettings.cs index ee113286..0d1c2add 100644 --- a/SafeExamBrowser.Contracts/Configuration/Settings/TaskbarSettings.cs +++ b/SafeExamBrowser.Contracts/Configuration/Settings/TaskbarSettings.cs @@ -10,6 +10,9 @@ using System; namespace SafeExamBrowser.Contracts.Configuration.Settings { + /// + /// Defines all configuration options for the . + /// [Serializable] public class TaskbarSettings { diff --git a/SafeExamBrowser.Contracts/I18n/IText.cs b/SafeExamBrowser.Contracts/I18n/IText.cs index be36376c..abaa9232 100644 --- a/SafeExamBrowser.Contracts/I18n/IText.cs +++ b/SafeExamBrowser.Contracts/I18n/IText.cs @@ -8,6 +8,10 @@ namespace SafeExamBrowser.Contracts.I18n { + /// + /// Provides access to text data. IMPORTANT: To allow for a complete internationalization of the application, all text elements which + /// are visible to the user must be retrieved via this module! + /// public interface IText { /// diff --git a/SafeExamBrowser.Contracts/I18n/ITextResource.cs b/SafeExamBrowser.Contracts/I18n/ITextResource.cs index 56ef14c4..fdfef654 100644 --- a/SafeExamBrowser.Contracts/I18n/ITextResource.cs +++ b/SafeExamBrowser.Contracts/I18n/ITextResource.cs @@ -10,6 +10,9 @@ using System.Collections.Generic; namespace SafeExamBrowser.Contracts.I18n { + /// + /// Defines a text resource, i.e. a source from which text data can be loaded. + /// public interface ITextResource { /// diff --git a/SafeExamBrowser.Contracts/I18n/TextKey.cs b/SafeExamBrowser.Contracts/I18n/TextKey.cs index f7615c03..3dc22fa9 100644 --- a/SafeExamBrowser.Contracts/I18n/TextKey.cs +++ b/SafeExamBrowser.Contracts/I18n/TextKey.cs @@ -9,7 +9,8 @@ namespace SafeExamBrowser.Contracts.I18n { /// - /// Defines all text components of the user interface. + /// Defines all text elements of the user interface. Use the pattern "Location_Description" to allow for a better overview over all + /// keys and their usage (where applicable). /// public enum TextKey { diff --git a/SafeExamBrowser.Contracts/Logging/ILogContentFormatter.cs b/SafeExamBrowser.Contracts/Logging/ILogContentFormatter.cs index 68042c23..cbd8bc15 100644 --- a/SafeExamBrowser.Contracts/Logging/ILogContentFormatter.cs +++ b/SafeExamBrowser.Contracts/Logging/ILogContentFormatter.cs @@ -8,6 +8,9 @@ namespace SafeExamBrowser.Contracts.Logging { + /// + /// Defines a formatter to be used to unify the look of and information rendered in an application log. + /// public interface ILogContentFormatter { /// diff --git a/SafeExamBrowser.Contracts/Logging/ILogMessage.cs b/SafeExamBrowser.Contracts/Logging/ILogMessage.cs index 683cabaf..119adeda 100644 --- a/SafeExamBrowser.Contracts/Logging/ILogMessage.cs +++ b/SafeExamBrowser.Contracts/Logging/ILogMessage.cs @@ -10,6 +10,9 @@ using System; namespace SafeExamBrowser.Contracts.Logging { + /// + /// Defines a typical (i.e. prioritized and timestamped) log message as content element of the application log. + /// public interface ILogMessage : ILogContent { /// diff --git a/SafeExamBrowser.Contracts/Logging/ILogObserver.cs b/SafeExamBrowser.Contracts/Logging/ILogObserver.cs index 52fc4298..1752f014 100644 --- a/SafeExamBrowser.Contracts/Logging/ILogObserver.cs +++ b/SafeExamBrowser.Contracts/Logging/ILogObserver.cs @@ -8,6 +8,9 @@ namespace SafeExamBrowser.Contracts.Logging { + /// + /// Defines an observer of the application log which can subscribe to a logger via . + /// public interface ILogObserver { /// diff --git a/SafeExamBrowser.Contracts/Logging/ILogText.cs b/SafeExamBrowser.Contracts/Logging/ILogText.cs index 69c1ad65..a2d9fe2f 100644 --- a/SafeExamBrowser.Contracts/Logging/ILogText.cs +++ b/SafeExamBrowser.Contracts/Logging/ILogText.cs @@ -8,6 +8,9 @@ namespace SafeExamBrowser.Contracts.Logging { + /// + /// Defines raw text data as content element of the application log. + /// public interface ILogText : ILogContent { /// diff --git a/SafeExamBrowser.Contracts/Logging/ILogger.cs b/SafeExamBrowser.Contracts/Logging/ILogger.cs index c0351bae..e832c554 100644 --- a/SafeExamBrowser.Contracts/Logging/ILogger.cs +++ b/SafeExamBrowser.Contracts/Logging/ILogger.cs @@ -11,6 +11,9 @@ using System.Collections.Generic; namespace SafeExamBrowser.Contracts.Logging { + /// + /// Defines the functionality of the logger. + /// public interface ILogger { /// diff --git a/SafeExamBrowser.Contracts/Logging/IThreadInfo.cs b/SafeExamBrowser.Contracts/Logging/IThreadInfo.cs index 5a6e2090..5c46062c 100644 --- a/SafeExamBrowser.Contracts/Logging/IThreadInfo.cs +++ b/SafeExamBrowser.Contracts/Logging/IThreadInfo.cs @@ -10,6 +10,9 @@ using System; namespace SafeExamBrowser.Contracts.Logging { + /// + /// Defines information about a thread, to be associated with an . + /// public interface IThreadInfo : ICloneable { /// diff --git a/SafeExamBrowser.Contracts/Logging/LogLevel.cs b/SafeExamBrowser.Contracts/Logging/LogLevel.cs index 37836a99..f6e0f044 100644 --- a/SafeExamBrowser.Contracts/Logging/LogLevel.cs +++ b/SafeExamBrowser.Contracts/Logging/LogLevel.cs @@ -9,7 +9,7 @@ namespace SafeExamBrowser.Contracts.Logging { /// - /// Defines the severity levels of the application log. + /// Defines all possible severity levels supported by the application's . /// public enum LogLevel { diff --git a/SafeExamBrowser.Contracts/Monitoring/IDisplayMonitor.cs b/SafeExamBrowser.Contracts/Monitoring/IDisplayMonitor.cs index 0349b1e9..49a72d6f 100644 --- a/SafeExamBrowser.Contracts/Monitoring/IDisplayMonitor.cs +++ b/SafeExamBrowser.Contracts/Monitoring/IDisplayMonitor.cs @@ -10,6 +10,9 @@ namespace SafeExamBrowser.Contracts.Monitoring { public delegate void DisplayChangedEventHandler(); + /// + /// Monitors the displays of the computer for (setup) changes and provides access to display-related functionality. + /// public interface IDisplayMonitor { /// diff --git a/SafeExamBrowser.Contracts/Monitoring/IKeyboardInterceptor.cs b/SafeExamBrowser.Contracts/Monitoring/IKeyboardInterceptor.cs index 37ce213a..f3c8bf22 100644 --- a/SafeExamBrowser.Contracts/Monitoring/IKeyboardInterceptor.cs +++ b/SafeExamBrowser.Contracts/Monitoring/IKeyboardInterceptor.cs @@ -8,6 +8,9 @@ namespace SafeExamBrowser.Contracts.Monitoring { + /// + /// Intercepts all keyboard input (except the Secure Attention Sequence: https://en.wikipedia.org/wiki/Secure_attention_key). + /// public interface IKeyboardInterceptor { /// diff --git a/SafeExamBrowser.Contracts/Monitoring/IMouseInterceptor.cs b/SafeExamBrowser.Contracts/Monitoring/IMouseInterceptor.cs index 77a50c86..538f9d20 100644 --- a/SafeExamBrowser.Contracts/Monitoring/IMouseInterceptor.cs +++ b/SafeExamBrowser.Contracts/Monitoring/IMouseInterceptor.cs @@ -8,6 +8,9 @@ namespace SafeExamBrowser.Contracts.Monitoring { + /// + /// Intercepts all mouse input. + /// public interface IMouseInterceptor { /// diff --git a/SafeExamBrowser.Contracts/Monitoring/IProcessMonitor.cs b/SafeExamBrowser.Contracts/Monitoring/IProcessMonitor.cs index 6c3bef07..41ae9fcb 100644 --- a/SafeExamBrowser.Contracts/Monitoring/IProcessMonitor.cs +++ b/SafeExamBrowser.Contracts/Monitoring/IProcessMonitor.cs @@ -12,6 +12,9 @@ namespace SafeExamBrowser.Contracts.Monitoring { public delegate void ExplorerStartedEventHandler(); + /// + /// Monitors the processes running on the computer and provides access to process-related functionality. + /// public interface IProcessMonitor { /// diff --git a/SafeExamBrowser.Contracts/Monitoring/IWindowMonitor.cs b/SafeExamBrowser.Contracts/Monitoring/IWindowMonitor.cs index 409df492..88d98b27 100644 --- a/SafeExamBrowser.Contracts/Monitoring/IWindowMonitor.cs +++ b/SafeExamBrowser.Contracts/Monitoring/IWindowMonitor.cs @@ -12,6 +12,9 @@ namespace SafeExamBrowser.Contracts.Monitoring { public delegate void WindowChangedEventHandler(IntPtr window); + /// + /// Monitors the windows associated with the current desktop and provides window-related functionality. + /// public interface IWindowMonitor { /// diff --git a/SafeExamBrowser.Contracts/Monitoring/KeyModifier.cs b/SafeExamBrowser.Contracts/Monitoring/KeyModifier.cs index 0cf4752a..e4a21bbb 100644 --- a/SafeExamBrowser.Contracts/Monitoring/KeyModifier.cs +++ b/SafeExamBrowser.Contracts/Monitoring/KeyModifier.cs @@ -10,6 +10,9 @@ using System; namespace SafeExamBrowser.Contracts.Monitoring { + /// + /// The key modifiers which can be detected by the . + /// [Flags] public enum KeyModifier { diff --git a/SafeExamBrowser.Contracts/Monitoring/KeyState.cs b/SafeExamBrowser.Contracts/Monitoring/KeyState.cs index a6ac083b..e4e73766 100644 --- a/SafeExamBrowser.Contracts/Monitoring/KeyState.cs +++ b/SafeExamBrowser.Contracts/Monitoring/KeyState.cs @@ -8,6 +8,9 @@ namespace SafeExamBrowser.Contracts.Monitoring { + /// + /// The key states which can be detected by the or . + /// public enum KeyState { None = 0, diff --git a/SafeExamBrowser.Contracts/Monitoring/MouseButton.cs b/SafeExamBrowser.Contracts/Monitoring/MouseButton.cs index 76a26c5a..8f2ec46c 100644 --- a/SafeExamBrowser.Contracts/Monitoring/MouseButton.cs +++ b/SafeExamBrowser.Contracts/Monitoring/MouseButton.cs @@ -8,6 +8,9 @@ namespace SafeExamBrowser.Contracts.Monitoring { + /// + /// The mouse buttons which can be detected by the . + /// public enum MouseButton { None = 0, diff --git a/SafeExamBrowser.Contracts/SystemComponents/BatteryChargeStatus.cs b/SafeExamBrowser.Contracts/SystemComponents/BatteryChargeStatus.cs index 24dff229..a66eb9c9 100644 --- a/SafeExamBrowser.Contracts/SystemComponents/BatteryChargeStatus.cs +++ b/SafeExamBrowser.Contracts/SystemComponents/BatteryChargeStatus.cs @@ -8,6 +8,9 @@ namespace SafeExamBrowser.Contracts.SystemComponents { + /// + /// Defines all possible charge statuses which can be determined by the application. + /// public enum BatteryChargeStatus { Undefined = 0, diff --git a/SafeExamBrowser.Contracts/SystemComponents/IKeyboardLayout.cs b/SafeExamBrowser.Contracts/SystemComponents/IKeyboardLayout.cs index c40c47db..cc29e190 100644 --- a/SafeExamBrowser.Contracts/SystemComponents/IKeyboardLayout.cs +++ b/SafeExamBrowser.Contracts/SystemComponents/IKeyboardLayout.cs @@ -10,6 +10,9 @@ using System; namespace SafeExamBrowser.Contracts.SystemComponents { + /// + /// Defines a keyboard layout which can be loaded by the application. + /// public interface IKeyboardLayout { /// diff --git a/SafeExamBrowser.Contracts/SystemComponents/ISystemComponent.cs b/SafeExamBrowser.Contracts/SystemComponents/ISystemComponent.cs index a6f6988a..1cd482b5 100644 --- a/SafeExamBrowser.Contracts/SystemComponents/ISystemComponent.cs +++ b/SafeExamBrowser.Contracts/SystemComponents/ISystemComponent.cs @@ -10,6 +10,10 @@ using SafeExamBrowser.Contracts.UserInterface.Taskbar; namespace SafeExamBrowser.Contracts.SystemComponents { + /// + /// Defines the functionality of a system component (e.g. the power supply). Each system component will get an + /// assigned, via which the user is able to interact with or get information about the underlying system component. + /// public interface ISystemComponent where TControl : ISystemControl { /// diff --git a/SafeExamBrowser.Contracts/SystemComponents/IWirelessNetwork.cs b/SafeExamBrowser.Contracts/SystemComponents/IWirelessNetwork.cs index 1213494d..5629cdd9 100644 --- a/SafeExamBrowser.Contracts/SystemComponents/IWirelessNetwork.cs +++ b/SafeExamBrowser.Contracts/SystemComponents/IWirelessNetwork.cs @@ -10,6 +10,9 @@ using System; namespace SafeExamBrowser.Contracts.SystemComponents { + /// + /// Defines a wireless network which can be connected to by the application. + /// public interface IWirelessNetwork { /// diff --git a/SafeExamBrowser.Contracts/SystemComponents/WirelessNetworkStatus.cs b/SafeExamBrowser.Contracts/SystemComponents/WirelessNetworkStatus.cs index 6a374871..febf3b96 100644 --- a/SafeExamBrowser.Contracts/SystemComponents/WirelessNetworkStatus.cs +++ b/SafeExamBrowser.Contracts/SystemComponents/WirelessNetworkStatus.cs @@ -8,6 +8,9 @@ namespace SafeExamBrowser.Contracts.SystemComponents { + /// + /// Defines all possible network statuses which can be determined by the application. + /// public enum WirelessNetworkStatus { Undefined = 0, diff --git a/SafeExamBrowser.Contracts/UserInterface/IBrowserControl.cs b/SafeExamBrowser.Contracts/UserInterface/IBrowserControl.cs index da331f5b..23fae85c 100644 --- a/SafeExamBrowser.Contracts/UserInterface/IBrowserControl.cs +++ b/SafeExamBrowser.Contracts/UserInterface/IBrowserControl.cs @@ -12,6 +12,10 @@ namespace SafeExamBrowser.Contracts.UserInterface public delegate void LoadingStateChangedEventHandler(bool isLoading); public delegate void TitleChangedEventHandler(string title); + /// + /// Defines the functionality of a browser control (i.e. an instance of the browser resp. its user interface) and is normally embedded + /// within an . + /// public interface IBrowserControl { /// diff --git a/SafeExamBrowser.Contracts/UserInterface/IBrowserWindow.cs b/SafeExamBrowser.Contracts/UserInterface/IBrowserWindow.cs index 1238f18c..ef9c3973 100644 --- a/SafeExamBrowser.Contracts/UserInterface/IBrowserWindow.cs +++ b/SafeExamBrowser.Contracts/UserInterface/IBrowserWindow.cs @@ -10,6 +10,9 @@ namespace SafeExamBrowser.Contracts.UserInterface { public delegate void ActionRequestedEventHandler(); + /// + /// Defines the functionality of a browser window, i.e. a window with an embedded browser instance (see ). + /// public interface IBrowserWindow : IWindow { /// diff --git a/SafeExamBrowser.Contracts/UserInterface/IMessageBox.cs b/SafeExamBrowser.Contracts/UserInterface/IMessageBox.cs index 5a932882..ed2ba72c 100644 --- a/SafeExamBrowser.Contracts/UserInterface/IMessageBox.cs +++ b/SafeExamBrowser.Contracts/UserInterface/IMessageBox.cs @@ -10,6 +10,9 @@ using SafeExamBrowser.Contracts.I18n; namespace SafeExamBrowser.Contracts.UserInterface { + /// + /// Defines the API for message boxes. + /// public interface IMessageBox { /// diff --git a/SafeExamBrowser.Contracts/UserInterface/IProgressIndicator.cs b/SafeExamBrowser.Contracts/UserInterface/IProgressIndicator.cs index d1fb2880..4408e32d 100644 --- a/SafeExamBrowser.Contracts/UserInterface/IProgressIndicator.cs +++ b/SafeExamBrowser.Contracts/UserInterface/IProgressIndicator.cs @@ -10,6 +10,9 @@ using SafeExamBrowser.Contracts.I18n; namespace SafeExamBrowser.Contracts.UserInterface { + /// + /// A progress indicator is a user interface element which displays the (completion) status of a procedure to the user. + /// public interface IProgressIndicator { /// diff --git a/SafeExamBrowser.Contracts/UserInterface/IRuntimeWindow.cs b/SafeExamBrowser.Contracts/UserInterface/IRuntimeWindow.cs index c03ab0b6..d8b87004 100644 --- a/SafeExamBrowser.Contracts/UserInterface/IRuntimeWindow.cs +++ b/SafeExamBrowser.Contracts/UserInterface/IRuntimeWindow.cs @@ -10,6 +10,10 @@ using SafeExamBrowser.Contracts.Logging; namespace SafeExamBrowser.Contracts.UserInterface { + /// + /// The main window of the runtime application component. It is controlled by the and serves + /// first of all as progress indicator for the user (e.g. during application startup & shutdown). + /// public interface IRuntimeWindow : ILogObserver, IProgressIndicator, IWindow { /// diff --git a/SafeExamBrowser.Contracts/UserInterface/ISplashScreen.cs b/SafeExamBrowser.Contracts/UserInterface/ISplashScreen.cs index a379c7ed..40bae391 100644 --- a/SafeExamBrowser.Contracts/UserInterface/ISplashScreen.cs +++ b/SafeExamBrowser.Contracts/UserInterface/ISplashScreen.cs @@ -10,10 +10,13 @@ using SafeExamBrowser.Contracts.Configuration; namespace SafeExamBrowser.Contracts.UserInterface { + /// + /// Defines the functionality of a splash screen. + /// public interface ISplashScreen : IProgressIndicator, IWindow { /// - /// The runtime information used to display version and copyright information. + /// The runtime information used to display version and copyright information. Can be updated during the execution of a procedure. /// RuntimeInfo RuntimeInfo { set; } } diff --git a/SafeExamBrowser.Contracts/UserInterface/IUserInterfaceFactory.cs b/SafeExamBrowser.Contracts/UserInterface/IUserInterfaceFactory.cs index d506ca65..7e93efb9 100644 --- a/SafeExamBrowser.Contracts/UserInterface/IUserInterfaceFactory.cs +++ b/SafeExamBrowser.Contracts/UserInterface/IUserInterfaceFactory.cs @@ -13,6 +13,11 @@ using SafeExamBrowser.Contracts.UserInterface.Taskbar; namespace SafeExamBrowser.Contracts.UserInterface { + /// + /// The factory for user interface elements which cannot be instantiated at the composition root. IMPORTANT: To allow for decoupling + /// from the particular user interface framework in use, all dynamically generated user interface elements must be generated by this + /// factory. + /// public interface IUserInterfaceFactory : IMessageBox { /// diff --git a/SafeExamBrowser.Contracts/UserInterface/IWindow.cs b/SafeExamBrowser.Contracts/UserInterface/IWindow.cs index 813e262d..c12f1156 100644 --- a/SafeExamBrowser.Contracts/UserInterface/IWindow.cs +++ b/SafeExamBrowser.Contracts/UserInterface/IWindow.cs @@ -10,6 +10,9 @@ namespace SafeExamBrowser.Contracts.UserInterface { public delegate void WindowClosingEventHandler(); + /// + /// Defines the functionality of a window. + /// public interface IWindow { /// diff --git a/SafeExamBrowser.Contracts/UserInterface/MessageBoxResult.cs b/SafeExamBrowser.Contracts/UserInterface/MessageBoxResult.cs index 4855fcc2..8d90c5cf 100644 --- a/SafeExamBrowser.Contracts/UserInterface/MessageBoxResult.cs +++ b/SafeExamBrowser.Contracts/UserInterface/MessageBoxResult.cs @@ -8,6 +8,9 @@ namespace SafeExamBrowser.Contracts.UserInterface { + /// + /// Defines all possible results of a message box. + /// public enum MessageBoxResult { None = 0, diff --git a/SafeExamBrowser.Contracts/UserInterface/Taskbar/IApplicationButton.cs b/SafeExamBrowser.Contracts/UserInterface/Taskbar/IApplicationButton.cs index 6b2d08a3..51604ea0 100644 --- a/SafeExamBrowser.Contracts/UserInterface/Taskbar/IApplicationButton.cs +++ b/SafeExamBrowser.Contracts/UserInterface/Taskbar/IApplicationButton.cs @@ -13,6 +13,9 @@ namespace SafeExamBrowser.Contracts.UserInterface.Taskbar { public delegate void ApplicationButtonClickedEventHandler(Guid? instanceId = null); + /// + /// The button of a (third-party) application which can be loaded into the . + /// public interface IApplicationButton { /// diff --git a/SafeExamBrowser.Contracts/UserInterface/Taskbar/INotificationButton.cs b/SafeExamBrowser.Contracts/UserInterface/Taskbar/INotificationButton.cs index c776e277..c2032db2 100644 --- a/SafeExamBrowser.Contracts/UserInterface/Taskbar/INotificationButton.cs +++ b/SafeExamBrowser.Contracts/UserInterface/Taskbar/INotificationButton.cs @@ -10,6 +10,9 @@ namespace SafeExamBrowser.Contracts.UserInterface.Taskbar { public delegate void NotificationButtonClickedEventHandler(); + /// + /// The button of a notification which can be loaded into the . + /// public interface INotificationButton { /// diff --git a/SafeExamBrowser.Contracts/UserInterface/Taskbar/ISystemControl.cs b/SafeExamBrowser.Contracts/UserInterface/Taskbar/ISystemControl.cs index 8f3e90dc..defd0077 100644 --- a/SafeExamBrowser.Contracts/UserInterface/Taskbar/ISystemControl.cs +++ b/SafeExamBrowser.Contracts/UserInterface/Taskbar/ISystemControl.cs @@ -8,6 +8,9 @@ namespace SafeExamBrowser.Contracts.UserInterface.Taskbar { + /// + /// The control of a system component which can be loaded into the . + /// public interface ISystemControl { /// diff --git a/SafeExamBrowser.Contracts/UserInterface/Taskbar/ISystemKeyboardLayoutControl.cs b/SafeExamBrowser.Contracts/UserInterface/Taskbar/ISystemKeyboardLayoutControl.cs index a02afa10..8c20ff6b 100644 --- a/SafeExamBrowser.Contracts/UserInterface/Taskbar/ISystemKeyboardLayoutControl.cs +++ b/SafeExamBrowser.Contracts/UserInterface/Taskbar/ISystemKeyboardLayoutControl.cs @@ -12,6 +12,9 @@ namespace SafeExamBrowser.Contracts.UserInterface.Taskbar { public delegate void KeyboardLayoutSelectedEventHandler(IKeyboardLayout layout); + /// + /// The control of the keyboard layout system component. + /// public interface ISystemKeyboardLayoutControl : ISystemControl { /// diff --git a/SafeExamBrowser.Contracts/UserInterface/Taskbar/ISystemPowerSupplyControl.cs b/SafeExamBrowser.Contracts/UserInterface/Taskbar/ISystemPowerSupplyControl.cs index 646d6fd1..691250e9 100644 --- a/SafeExamBrowser.Contracts/UserInterface/Taskbar/ISystemPowerSupplyControl.cs +++ b/SafeExamBrowser.Contracts/UserInterface/Taskbar/ISystemPowerSupplyControl.cs @@ -10,6 +10,9 @@ using SafeExamBrowser.Contracts.SystemComponents; namespace SafeExamBrowser.Contracts.UserInterface.Taskbar { + /// + /// The control of the power supply system component. + /// public interface ISystemPowerSupplyControl : ISystemControl { /// diff --git a/SafeExamBrowser.Contracts/UserInterface/Taskbar/ISystemWirelessNetworkControl.cs b/SafeExamBrowser.Contracts/UserInterface/Taskbar/ISystemWirelessNetworkControl.cs index b9dcef47..3ff921a0 100644 --- a/SafeExamBrowser.Contracts/UserInterface/Taskbar/ISystemWirelessNetworkControl.cs +++ b/SafeExamBrowser.Contracts/UserInterface/Taskbar/ISystemWirelessNetworkControl.cs @@ -13,6 +13,9 @@ namespace SafeExamBrowser.Contracts.UserInterface.Taskbar { public delegate void WirelessNetworkSelectedEventHandler(IWirelessNetwork network); + /// + /// The control of the wireless network system component. + /// public interface ISystemWirelessNetworkControl : ISystemControl { /// diff --git a/SafeExamBrowser.Contracts/UserInterface/Taskbar/ITaskbar.cs b/SafeExamBrowser.Contracts/UserInterface/Taskbar/ITaskbar.cs index 5ee04a47..d24d16b2 100644 --- a/SafeExamBrowser.Contracts/UserInterface/Taskbar/ITaskbar.cs +++ b/SafeExamBrowser.Contracts/UserInterface/Taskbar/ITaskbar.cs @@ -10,6 +10,10 @@ namespace SafeExamBrowser.Contracts.UserInterface.Taskbar { public delegate void QuitButtonClickedEventHandler(); + /// + /// Defines the functionality of the application taskbar. The taskbar is the main user interface element via which the user can access + /// the browser, third-party applications, system controls and so on. + /// public interface ITaskbar { /// diff --git a/SafeExamBrowser.Contracts/WindowsApi/IBounds.cs b/SafeExamBrowser.Contracts/WindowsApi/IBounds.cs index 4328690e..e536e98c 100644 --- a/SafeExamBrowser.Contracts/WindowsApi/IBounds.cs +++ b/SafeExamBrowser.Contracts/WindowsApi/IBounds.cs @@ -8,6 +8,9 @@ namespace SafeExamBrowser.Contracts.WindowsApi { + /// + /// Defines rectangular bounds, e.g. used for display-related operations (see ). + /// public interface IBounds { int Left { get; } diff --git a/SafeExamBrowser.Contracts/WindowsApi/IDesktop.cs b/SafeExamBrowser.Contracts/WindowsApi/IDesktop.cs index dce2202e..0ec80045 100644 --- a/SafeExamBrowser.Contracts/WindowsApi/IDesktop.cs +++ b/SafeExamBrowser.Contracts/WindowsApi/IDesktop.cs @@ -8,6 +8,9 @@ namespace SafeExamBrowser.Contracts.WindowsApi { + /// + /// Defines the API to retrieve information about desktops and perform desktop-related operations. + /// public interface IDesktop { /// diff --git a/SafeExamBrowser.Contracts/WindowsApi/INativeMethods.cs b/SafeExamBrowser.Contracts/WindowsApi/INativeMethods.cs index 6522f088..9e37ca7c 100644 --- a/SafeExamBrowser.Contracts/WindowsApi/INativeMethods.cs +++ b/SafeExamBrowser.Contracts/WindowsApi/INativeMethods.cs @@ -12,6 +12,9 @@ using SafeExamBrowser.Contracts.Monitoring; namespace SafeExamBrowser.Contracts.WindowsApi { + /// + /// Defines and wraps the functionality available via the native Windows API. + /// public interface INativeMethods { /// diff --git a/SafeExamBrowser.Contracts/WindowsApi/IProcess.cs b/SafeExamBrowser.Contracts/WindowsApi/IProcess.cs index 2b310acb..efd8fa52 100644 --- a/SafeExamBrowser.Contracts/WindowsApi/IProcess.cs +++ b/SafeExamBrowser.Contracts/WindowsApi/IProcess.cs @@ -10,6 +10,9 @@ namespace SafeExamBrowser.Contracts.WindowsApi { public delegate void ProcessTerminatedEventHandler(int exitCode); + /// + /// Represents a process and defines its functionality. + /// public interface IProcess { /// diff --git a/SafeExamBrowser.Contracts/WindowsApi/IProcessFactory.cs b/SafeExamBrowser.Contracts/WindowsApi/IProcessFactory.cs index 6cb1e1d9..eba52a10 100644 --- a/SafeExamBrowser.Contracts/WindowsApi/IProcessFactory.cs +++ b/SafeExamBrowser.Contracts/WindowsApi/IProcessFactory.cs @@ -8,6 +8,9 @@ namespace SafeExamBrowser.Contracts.WindowsApi { + /// + /// The factory for processes, to be used whenever a new process needs to be created (for internal components and third-party applications). + /// public interface IProcessFactory { ///