Fix doxygen errors

This commit is contained in:
Cyberboss
2017-10-19 12:24:31 -04:00
parent 97fdf34b9a
commit 1812841748
6 changed files with 13 additions and 23 deletions
+3 -1
View File
@@ -82,7 +82,9 @@ namespace TGServerService
/// <param name="speaker">The username of the speaker</param>
/// <param name="channel">The name of the channel</param>
/// <param name="message">The message text</param>
/// <param name="tagged">true if the bot was mentioned in the first word, false otherwise</param>
/// <param name="isAdmin"><see langword="true"/> if <paramref name="speaker"/> is considered a chat admin, <see langword="false"/> otherwise</param>
/// <param name="isAdminChannel"><see langword="true"/> if <paramref name="channel"/> is an admin chat channel, <see langword="false"/> otherwise</param>
delegate void OnChatMessage(ITGChatProvider ChatProvider, string speaker, string channel, string message, bool isAdmin, bool isAdminChannel);
partial class TGStationServer : ITGChat
+1 -2
View File
@@ -109,7 +109,7 @@ namespace TGServiceInterface
/// <summary>
/// Properly formats a <paramref name="channel"/> name for the <see cref="TGChatProvider"/>
/// </summary>
/// <param name="working">The <see cref="string"/> to format</param>
/// <param name="channel">The <see cref="string"/> to format</param>
/// <returns>The formatted <see cref="string"/></returns>
protected virtual string SanitizeChannelName(string channel)
{
@@ -137,7 +137,6 @@ namespace TGServiceInterface
/// Constructs a <see cref="TGChatSetupInfo"/> from a data list
/// </summary>
/// <param name="DeserializedData">The data</param>
/// <param name="provider">The chat provider</param>
public TGChatSetupInfo(IList<string> DeserializedData)
{
DataFields = DeserializedData;
+1
View File
@@ -29,6 +29,7 @@ namespace TGServiceInterface
/// <summary>
/// The proc that DD calls to access <see cref="ITGInterop"/>
/// </summary>
/// <param name="argc">The number of arguments passed</param>
/// <param name="args">The arguments passed</param>
/// <returns>0</returns>
[DllExport("DDEntryPoint", CallingConvention = CallingConvention.Cdecl)]
+1 -1
View File
@@ -110,7 +110,7 @@ namespace TGServiceInterface
/// <summary>
/// Hard checks out the passed object name
/// </summary>
/// <param name="branchorsha">The branch, commit, or tag to checkout</param>
/// <param name="objectName">The branch, commit, or tag to checkout</param>
/// <returns><see langword="null"/> on success, error message on failure</returns>
[OperationContract]
string Checkout(string objectName);
+6 -4
View File
@@ -152,10 +152,12 @@ namespace TGServiceInterface
}
/// <summary>
/// Set the interface to look for services on a remote computer
/// Set the remote <see cref="Server"/> to connect to along with
/// </summary>
/// <param name="address"></param>
/// <param name="port"></param>
/// <param name="address">The address of the remote server</param>
/// <param name="port">The port the remote server runs on</param>
/// <param name="username">Windows account username for the remote server</param>
/// <param name="password">Windows account password for the remote server</param>
public static void SetRemoteLoginInformation(string address, ushort port, string username, string password)
{
HTTPSURL = address;
@@ -168,7 +170,7 @@ namespace TGServiceInterface
/// <summary>
/// Safely shuts down a single <see cref="ChannelFactory"/>
/// </summary>
/// <param name="cf"></param>
/// <param name="cf">The <see cref="ChannelFactory"/> to shutdown</param>
public static void CloseChannel(ChannelFactory cf)
{
try
+1 -15
View File
@@ -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.