Skip to content

Commit

Permalink
Cleared some more warnings with regards to xml documentation.
Browse files Browse the repository at this point in the history
Signed-off-by: Konstantina Chremmou <[email protected]>
  • Loading branch information
kc284 authored and MihaelaStoica committed Apr 3, 2018
1 parent c96fd64 commit 585f7a8
Show file tree
Hide file tree
Showing 11 changed files with 36 additions and 18 deletions.
2 changes: 2 additions & 0 deletions XenAdmin/Dialogs/InputPromptDialog.cs
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ public InputPromptDialog()
/// <param name="owner"></param>
/// <param name="message"></param>
/// <param name="title"></param>
/// <param name="helpID"></param>
/// <returns>null if the user cancelled, otherwise the string they gave.</returns>
public static String Prompt(IWin32Window owner, String message, String title, String helpID)
{
Expand All @@ -67,6 +68,7 @@ public static String Prompt(IWin32Window owner, String message, String title, St
/// <param name="message"></param>
/// <param name="title"></param>
/// <param name="defaultInput"></param>
/// <param name="helpID"></param>
/// <returns>null if the user cancelled, otherwise the string they gave.</returns>
public static String Prompt(IWin32Window owner, String message, String title, String defaultInput, String helpID)
{
Expand Down
1 change: 1 addition & 0 deletions XenAdmin/Dialogs/ThreeButtonDialog.cs
Original file line number Diff line number Diff line change
Expand Up @@ -261,6 +261,7 @@ public TBDButton(string label, DialogResult result, ButtonType isDefaultButton)
/// <param name="label">The label for the button</param>
/// <param name="result">The result to return on click.</param>
/// <param name="isDefaultButton">The role the button plays in the dialog</param>
/// <param name="select"></param>
public TBDButton(string label, DialogResult result, ButtonType isDefaultButton, bool select)
: this(label, result, isDefaultButton)
{
Expand Down
3 changes: 3 additions & 0 deletions XenAdmin/GroupingTag.cs
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,10 @@ public class GroupingTag
internal object Parent;
internal object Group;

/// <summary></summary>
/// <param name="grouping"></param>
/// <param name="parent">May be null.</param>
/// <param name="group"></param>
internal GroupingTag(Grouping grouping, object parent, object group)
{
System.Diagnostics.Trace.Assert(grouping != null);
Expand Down
2 changes: 2 additions & 0 deletions XenAdmin/LicenseTimer.cs
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,8 @@ private void showLicenseSummaryWarning(String hostname, DateTime now, DateTime e
/// <param name="host"></param>
/// <param name="now"></param>
/// <param name="expiryDate">Should be expressed in local time.</param>
/// <param name="createAlert"></param>
/// <param name="popupLicenseMgr"></param>
private void showLicenseSummaryExpired(Host host, DateTime now, DateTime expiryDate, bool createAlert, bool popupLicenseMgr)
{
Program.AssertOnEventThread();
Expand Down
1 change: 1 addition & 0 deletions XenAdmin/MainWindowTreeBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ public object HighlightedDragTarget
/// </summary>
/// <param name="newRootNode">The new root node.</param>
/// <param name="searchText">The search text for the currently active search.</param>
/// <param name="searchMode"></param>
public void RefreshTreeView(VirtualTreeNode newRootNode, string searchText, NavigationPane.NavigationMode searchMode)
{
Util.ThrowIfParameterNull(newRootNode, "newRootNode");
Expand Down
25 changes: 20 additions & 5 deletions XenAdmin/Plugins/Cmd/XenServerPowerShellCmd.cs
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,26 @@ namespace XenAdmin.Plugins
internal class XenServerPowershellCmd : ShellCmd
{
// TODO: CA:40580: These version numbers are not checked anywhere at the moment, and thus are not documented as part of the plugin spec
public readonly Version SnapInMinVersion; // optional - "version_min" attribute on the "XenServerPowerShellCmd" tag
public readonly Version SnapInMaxVersion; // optional - "version_max" attribute on the "XenServerPowerShellCmd" tag

public readonly bool Debug; // optional - "debug" attribute on the "XenServerPowerShellCmd" tag
public readonly string Function; // optional - "function" attribute on the "PowerShellCmd" tag
/// <summary>
/// optional - "version_min" attribute on the "XenServerPowerShellCmd" tag
/// </summary>
public readonly Version SnapInMinVersion;
#pragma warning disable 649, 169
/// <summary>
/// optional - "version_max" attribute on the "XenServerPowerShellCmd" tag
/// </summary>
public readonly Version SnapInMaxVersion;
#pragma warning restore 649, 169

/// <summary>
/// optional - "debug" attribute on the "XenServerPowerShellCmd" tag
/// </summary>
public readonly bool Debug;

/// <summary>
/// optional - "function" attribute on the "PowerShellCmd" tag
/// </summary>
public readonly string Function;

public const string ATT_DEBUG = "debug";
public const string ATT_VERSION_MIN = "version_min";
Expand Down
2 changes: 1 addition & 1 deletion XenAdmin/UpdateManager.DelayCalculator.cs
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ private class DelayCalculator
/// <summary>
/// Call this to register an updates that took the specified length of time (in ms).
/// </summary>
/// <param name="ms">The length of time that the update took (in ms).</param>
/// <param name="duration">The length of time that the update took (in ms).</param>
public void RegisterLatestUpdate(long duration)
{
if (duration > 0)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,6 @@ public class DelayLoadingOptionComboBoxItem : IEnableableXenObjectComboBoxItem
/// <summary>
/// Creates a new class instance and starts a thread to load data
/// </summary>
/// <param name="xenObject"></param>
public DelayLoadingOptionComboBoxItem(IXenObject xenObject, List<ReasoningFilter> filters)
{
this.xenObject = xenObject;
Expand Down
4 changes: 2 additions & 2 deletions XenAdmin/Wlb/WlbReportInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -73,11 +73,11 @@ public class WlbReportInfo
/// </summary>
/// <param name="reportName">The name of the report to be rendered</param>
/// <param name="reportFile">The RDLC file name for the report</param>
/// <param name="reportDefinition"></param>
/// <param name="DisplayHosts">Whether or not the report requires a host parameter value</param>
/// <param name="DisplayFilter"></param>
/// <param name="DisplayUsers">Whether or not the report requires a user parameter value</param>
/// <param name="DisplayAuditObjects">Whether or not the report requires a audit object parameter value</param>
/// <param name="UserNames">List of user names whose values are required for the SQL query</param>
/// <param name="AuditObjectNames">List of audit object names whose values are required for the SQL query</param>
/// <param name="reportQueryParameterNames">List of parameter names whose values are required for the SQL query</param>
public WlbReportInfo(string reportName,
string reportFile,
Expand Down
11 changes: 2 additions & 9 deletions XenAdmin/Wlb/WlbReports/WorkloadReports.cs
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,6 @@ public WorkloadReports() : this(string.Empty, false) {}
/// <summary>
/// Overloaded constructor provides access to a specific report upon load
/// </summary>
/// <param name="reportName"></param>
public WorkloadReports(string reportFile, bool run)
{
InitializeComponent();
Expand Down Expand Up @@ -744,7 +743,6 @@ private TreeNode GetReportTreeNode(XmlNode currentNode)
/// <summary>
/// Creates a treeNode for give report name and subscription object
/// </summary>
/// <param name="reportName">Name of the report that has the subscription</param>
/// <param name="subscription">Instance of a subscription</param>
/// <returns>Return a instance of TreeNode</returns>
private TreeNode GetReportSubscriptionTreeNode(WlbReportSubscription subscription)
Expand Down Expand Up @@ -807,10 +805,10 @@ private OrderedDictionary GetSQLQueryParamNames(XmlNode currentNode, XmlElement
/// <summary>
/// Add subscription nodes if a report has subscriptions
/// </summary>
/// <param name="topNode">Report subscription top node</param>
/// <param name="subscriptionList">A dictionary contains WlbReportSubscription instances</param>
/// <param name="subscriptions"></param>
/// <param name="reportName">Report display name that can be added to WlbReportSubscription instance</param>
/// <param name="selectedSub">The original selected node before update</param>
/// <param name="subscriptionFolder"></param>
private void AddNewSubscriptionNode(TreeNode subscriptionFolder, Dictionary<string, WlbReportSubscription> subscriptions, string reportName, WlbReportSubscription selectedSub)
{
foreach (WlbReportSubscription sub in subscriptions.Values)
Expand Down Expand Up @@ -988,11 +986,6 @@ private void wlbReportView1_ReportDrilledThrough(object sender, DrillthroughEven
SynchTreeViewReportList(e.ReportPath.ToString());
}


/// <summary>
/// Event handler for report close button
/// </summary>
/// <param name="sender"></param>
private void wlbReportView1_Close(object sender, EventArgs e)
{
this.Close();
Expand Down
2 changes: 2 additions & 0 deletions XenAdmin/Wlb/WlbScheduledTask.cs
Original file line number Diff line number Diff line change
Expand Up @@ -567,6 +567,8 @@ public SortedDictionary<int, WlbScheduledTask> SortedTaskList
return sortedTasks;
}
}

/// <summary>
/// Exposes a virtual representation of the WlbScheduledTasks collection, in which aggregate days
/// are separated into individual days. The entire list is also presorted chronologically.
/// </summary>
Expand Down

0 comments on commit 585f7a8

Please sign in to comment.