Docs: Removed file comments and added missing code documentation

Please note that file comments had no purpose in nearly all cases and just added visual clutter. The two files that had meaningful file comments had their comments moved into the corresponding classes. There are still hundreds of file comments left in other files that will be removed over time.

Also cleaned up some random stuff along the way:
- relative paths to public headers within the same module are no longer necessary (automatically discovered by UBT now)
- header guards are deprecated, use #pragma once instead (all compilers support it now)
- space between multiple template brackets is no longer required (all compilers support >> now)
- NULL to nullptr, OVERRIDE to override
- spelling errors, whitespace, line breaks

[CL 2104067 by Max Preussner in Main branch]
This commit is contained in:
Max Preussner
2014-06-12 23:22:18 -04:00
committed by UnrealBot
parent 5776ee4dc3
commit 3aece47882
680 changed files with 2121 additions and 5775 deletions
@@ -1,9 +1,5 @@
// Copyright 1998-2014 Epic Games, Inc. All Rights Reserved.
/*=============================================================================
SessionBrowserOwnerFilter.h: Declares the FSessionBrowserOwnerFilter class.
=============================================================================*/
#pragma once
@@ -1,9 +1,5 @@
// Copyright 1998-2014 Epic Games, Inc. All Rights Reserved.
/*=============================================================================
SessionConsoleCategoryFilter.h: Declares the FSessionConsoleCategoryFilter class.
=============================================================================*/
#pragma once
@@ -1,9 +1,5 @@
// Copyright 1998-2014 Epic Games, Inc. All Rights Reserved.
/*=============================================================================
SessionConsoleCommands.h: Declares the FSessionConsoleCommands class.
=============================================================================*/
#pragma once
@@ -28,17 +24,15 @@ public:
public:
// Begin TCommands interface
// TCommands interface
virtual void RegisterCommands( ) OVERRIDE
virtual void RegisterCommands( ) override
{
UI_COMMAND(Clear, "Clear Log", "Clear the log window", EUserInterfaceActionType::Button, FInputGesture());
UI_COMMAND(SessionCopy, "Copy", "Copy the selected log messages to the clipboard", EUserInterfaceActionType::Button, FInputGesture());
UI_COMMAND(SessionSave, "Save Log...", "Save the entire log to a file", EUserInterfaceActionType::ToggleButton, FInputGesture());
}
// End TCommands interface
public:
TSharedPtr<FUICommandInfo> Clear;
@@ -1,9 +1,5 @@
// Copyright 1998-2014 Epic Games, Inc. All Rights Reserved.
/*=============================================================================
SessionConsoleLogMessage.h: Declares the FSessionConsoleLogMessage structure.
=============================================================================*/
#pragma once
@@ -1,9 +1,5 @@
// Copyright 1998-2014 Epic Games, Inc. All Rights Reserved.
/*=============================================================================
SessionConsoleVerbosityFilter.h: Declares the FSessionConsoleVerbosityFilter class.
=============================================================================*/
#pragma once
@@ -1,9 +1,5 @@
// Copyright 1998-2014 Epic Games, Inc. All Rights Reserved.
/*=============================================================================
SessionFrontendModule.cpp: Implements the FSessionFrontendModule class.
=============================================================================*/
#include "SessionFrontendPrivatePCH.h"
@@ -18,25 +14,23 @@ class FSessionFrontendModule
{
public:
// Begin ISessionFrontendModule interface
// ISessionFrontendModule interface
virtual TSharedRef<class SWidget> CreateSessionBrowser( const ISessionManagerRef& SessionManager ) OVERRIDE
virtual TSharedRef<class SWidget> CreateSessionBrowser( const ISessionManagerRef& SessionManager ) override
{
return SNew(SSessionBrowser, SessionManager);
}
virtual TSharedRef<class SWidget> CreateSessionConsole( const ISessionManagerRef& SessionManager ) OVERRIDE
virtual TSharedRef<class SWidget> CreateSessionConsole( const ISessionManagerRef& SessionManager ) override
{
return SNew(SSessionConsole, SessionManager);
}
// End ISessionFrontendModule interface
public:
// Begin IModuleInterface interface
// IModuleInterface interface
virtual void StartupModule( ) OVERRIDE
virtual void StartupModule( ) override
{
FGlobalTabmanager::Get()->RegisterTabSpawner(SessionFrontendTabName, FOnSpawnTab::CreateRaw(this, &FSessionFrontendModule::SpawnSessionFrontendTab))
.SetDisplayName(NSLOCTEXT("FSessionFrontendModule", "FrontendTabTitle", "Session Frontend"))
@@ -44,12 +38,10 @@ public:
.SetIcon(FSlateIcon(FEditorStyle::GetStyleSetName(), "SessionFrontEnd.TabIcon"));
}
virtual void ShutdownModule( ) OVERRIDE
virtual void ShutdownModule( ) override
{
FGlobalTabmanager::Get()->UnregisterTabSpawner(SessionFrontendTabName);
}
// End IModuleInterface interface
private:
@@ -57,7 +49,6 @@ private:
* Creates a new session front-end tab.
*
* @param SpawnTabArgs - The arguments for the tab to spawn.
*
* @return The spawned tab.
*/
TSharedRef<SDockTab> SpawnSessionFrontendTab( const FSpawnTabArgs& SpawnTabArgs )
@@ -1,9 +1,5 @@
// Copyright 1998-2014 Epic Games, Inc. All Rights Reserved.
/*=============================================================================
SessionFrontendPrivatePCH.h: Pre-compiled header file for the SessionFrontend module.
=============================================================================*/
#pragma once
#include "SessionFrontend.h"
@@ -1,9 +1,5 @@
// Copyright 1998-2014 Epic Games, Inc. All Rights Reserved.
/*=============================================================================
SSessionBrowser.cpp: Implements the SSessionBrowser class.
=============================================================================*/
#include "SessionFrontendPrivatePCH.h"
@@ -1,9 +1,5 @@
// Copyright 1998-2014 Epic Games, Inc. All Rights Reserved.
/*=============================================================================
SSessionBrowser.h: Declares the SSessionBrowser class.
=============================================================================*/
#pragma once
@@ -1,9 +1,5 @@
// Copyright 1998-2014 Epic Games, Inc. All Rights Reserved.
/*=============================================================================
SSessionBrowserCommandBar.cpp: Implements the SSessionBrowserCommandBar class.
=============================================================================*/
#include "SessionFrontendPrivatePCH.h"
@@ -1,9 +1,5 @@
// Copyright 1998-2014 Epic Games, Inc. All Rights Reserved.
/*=============================================================================
SSessionBrowserCommandBar.h: Declares the SSessionBrowserCommandBar class.
=============================================================================*/
#pragma once
@@ -1,9 +1,5 @@
// Copyright 1998-2014 Epic Games, Inc. All Rights Reserved.
/*=============================================================================
SSessionInstanceList.h: Declares the SSessionInstanceList class.
=============================================================================*/
#pragma once
@@ -1,9 +1,5 @@
// Copyright 1998-2014 Epic Games, Inc. All Rights Reserved.
/*=============================================================================
SSessionBrowserInstanceListRow.h: Declares the SSessionBrowserInstanceListRow class.
=============================================================================*/
#pragma once
@@ -1,9 +1,5 @@
// Copyright 1998-2014 Epic Games, Inc. All Rights Reserved.
/*=============================================================================
SSessionBrowserSessionListRow.h: Declares the SSessionBrowserSessionListRow class.
=============================================================================*/
#pragma once
@@ -1,9 +1,5 @@
// Copyright 1998-2014 Epic Games, Inc. All Rights Reserved.
/*=============================================================================
SSessionConsolePanel.cpp: Implements the SSessionConsolePanel class.
=============================================================================*/
#include "SessionFrontendPrivatePCH.h"
@@ -1,9 +1,5 @@
// Copyright 1998-2014 Epic Games, Inc. All Rights Reserved.
/*=============================================================================
SSessionConsolePanel.h: Declares the SSessionConsolePanel class.
=============================================================================*/
#pragma once
@@ -1,9 +1,5 @@
// Copyright 1998-2014 Epic Games, Inc. All Rights Reserved.
/*=============================================================================
SSessionConsoleCommandBar.cpp: Implements the SSessionConsoleCommandBar class.
=============================================================================*/
#include "SessionFrontendPrivatePCH.h"
@@ -1,9 +1,5 @@
// Copyright 1998-2014 Epic Games, Inc. All Rights Reserved.
/*=============================================================================
SSessionConsoleCommandBar.h: Declares the SSessionConsoleCommandBar class.
=============================================================================*/
#pragma once
@@ -25,14 +21,10 @@ public:
SLATE_BEGIN_ARGS(SSessionConsoleCommandBar) { }
/**
* Called when the filter settings have changed.
*/
/** Called when the filter settings have changed. */
SLATE_EVENT(FOnSessionConsoleCommandSubmitted, OnCommandSubmitted)
/**
* Called when the promote to shortcut button is clicked.
*/
/** Called when the promote to shortcut button is clicked. */
SLATE_EVENT(FOnSessionConsoleCommandSubmitted, OnPromoteToShortcutClicked)
SLATE_END_ARGS()
@@ -1,9 +1,5 @@
// Copyright 1998-2014 Epic Games, Inc. All Rights Reserved.
/*=============================================================================
SSessionConsoleFilterBar.cpp: Implements the SSessionConsoleFilterBar class.
=============================================================================*/
#include "SessionFrontendPrivatePCH.h"
@@ -1,9 +1,5 @@
// Copyright 1998-2014 Epic Games, Inc. All Rights Reserved.
/*=============================================================================
SSessionConsoleFilterBar.h: Declares the SSessionConsoleFilterBar class.
=============================================================================*/
#pragma once
@@ -17,9 +13,7 @@ public:
SLATE_BEGIN_ARGS(SSessionConsoleFilterBar) { }
/**
* Called when the filter settings have changed.
*/
/** Called when the filter settings have changed. */
SLATE_EVENT(FSimpleDelegate, OnFilterChanged)
SLATE_END_ARGS()

Some files were not shown because too many files have changed in this diff Show More