From 1812841748e2df3e39546384ace7876eba62017f Mon Sep 17 00:00:00 2001 From: Cyberboss Date: Thu, 19 Oct 2017 12:24:31 -0400 Subject: [PATCH] Fix doxygen errors --- TGServerService/Chat.cs | 4 +++- TGServiceInterface/ChatProvider.cs | 3 +-- TGServiceInterface/Interop.cs | 1 + TGServiceInterface/Repository.cs | 2 +- TGServiceInterface/Server.cs | 10 ++++++---- Tools/Doxyfile | 16 +--------------- 6 files changed, 13 insertions(+), 23 deletions(-) diff --git a/TGServerService/Chat.cs b/TGServerService/Chat.cs index 12ced80fa9..35e246c696 100644 --- a/TGServerService/Chat.cs +++ b/TGServerService/Chat.cs @@ -82,7 +82,9 @@ namespace TGServerService /// The username of the speaker /// The name of the channel /// The message text - /// true if the bot was mentioned in the first word, false otherwise + /// if is considered a chat admin, otherwise + /// if is an admin chat channel, otherwise + delegate void OnChatMessage(ITGChatProvider ChatProvider, string speaker, string channel, string message, bool isAdmin, bool isAdminChannel); partial class TGStationServer : ITGChat diff --git a/TGServiceInterface/ChatProvider.cs b/TGServiceInterface/ChatProvider.cs index 5c28f5b1c8..7daa52281b 100644 --- a/TGServiceInterface/ChatProvider.cs +++ b/TGServiceInterface/ChatProvider.cs @@ -109,7 +109,7 @@ namespace TGServiceInterface /// /// Properly formats a name for the /// - /// The to format + /// The to format /// The formatted protected virtual string SanitizeChannelName(string channel) { @@ -137,7 +137,6 @@ namespace TGServiceInterface /// Constructs a from a data list /// /// The data - /// The chat provider public TGChatSetupInfo(IList DeserializedData) { DataFields = DeserializedData; diff --git a/TGServiceInterface/Interop.cs b/TGServiceInterface/Interop.cs index 81672fe241..da00e31237 100644 --- a/TGServiceInterface/Interop.cs +++ b/TGServiceInterface/Interop.cs @@ -29,6 +29,7 @@ namespace TGServiceInterface /// /// The proc that DD calls to access /// + /// The number of arguments passed /// The arguments passed /// 0 [DllExport("DDEntryPoint", CallingConvention = CallingConvention.Cdecl)] diff --git a/TGServiceInterface/Repository.cs b/TGServiceInterface/Repository.cs index ed84a700d4..7119d76927 100644 --- a/TGServiceInterface/Repository.cs +++ b/TGServiceInterface/Repository.cs @@ -110,7 +110,7 @@ namespace TGServiceInterface /// /// Hard checks out the passed object name /// - /// The branch, commit, or tag to checkout + /// The branch, commit, or tag to checkout /// on success, error message on failure [OperationContract] string Checkout(string objectName); diff --git a/TGServiceInterface/Server.cs b/TGServiceInterface/Server.cs index dc127b5d8a..07f8a91c76 100644 --- a/TGServiceInterface/Server.cs +++ b/TGServiceInterface/Server.cs @@ -152,10 +152,12 @@ namespace TGServiceInterface } /// - /// Set the interface to look for services on a remote computer + /// Set the remote to connect to along with /// - /// - /// + /// The address of the remote server + /// The port the remote server runs on + /// Windows account username for the remote server + /// Windows account password for the remote server public static void SetRemoteLoginInformation(string address, ushort port, string username, string password) { HTTPSURL = address; @@ -168,7 +170,7 @@ namespace TGServiceInterface /// /// Safely shuts down a single /// - /// + /// The to shutdown public static void CloseChannel(ChannelFactory cf) { try diff --git a/Tools/Doxyfile b/Tools/Doxyfile index 89d539777c..a323f80087 100644 --- a/Tools/Doxyfile +++ b/Tools/Doxyfile @@ -303,15 +303,6 @@ EXTENSION_MAPPING = MARKDOWN_SUPPORT = YES -# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up -# to that level are automatically included in the table of contents, even if -# they do not have an id attribute. -# Note: This feature currently applies only to Markdown headings. -# Minimum value: 0, maximum value: 99, default value: 0. -# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. - -TOC_INCLUDE_HEADINGS = 0 - # When enabled doxygen tries to link words that correspond to documented # classes, or namespaces to their corresponding documentation. Such a link can # be prevented in individual cases by putting a % sign in front of the word or @@ -874,7 +865,7 @@ RECURSIVE = YES # run. #We want the main .md -EXCLUDE = legacy/README.md +EXCLUDE = legacy/README.md packages # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded @@ -2422,11 +2413,6 @@ DIAFILE_DIRS = PLANTUML_JAR_PATH = -# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a -# configuration file for plantuml. - -PLANTUML_CFG_FILE = - # When using plantuml, the specified paths are searched for files specified by # the !include statement in a plantuml block.