| Index: visual_studio/NativeClientVSAddIn/NativeClientVSAddIn/NativeClientVSAddIn.xml
|
| diff --git a/visual_studio/NativeClientVSAddIn/NativeClientVSAddIn/NativeClientVSAddIn.xml b/visual_studio/NativeClientVSAddIn/NativeClientVSAddIn/NativeClientVSAddIn.xml
|
| new file mode 100644
|
| index 0000000000000000000000000000000000000000..b0653e41f7bdb33cf90c43b179c84662345fc73d
|
| --- /dev/null
|
| +++ b/visual_studio/NativeClientVSAddIn/NativeClientVSAddIn/NativeClientVSAddIn.xml
|
| @@ -0,0 +1,292 @@
|
| +<?xml version="1.0"?>
|
| +<doc>
|
| + <assembly>
|
| + <name>NativeClientVSAddIn</name>
|
| + </assembly>
|
| + <members>
|
| + <member name="T:NativeClientVSAddIn.Connect">
|
| + <summary>The object for implementing an Add-in.</summary>
|
| + <seealso class='IDTExtensibility2' />
|
| + </member>
|
| + <member name="M:NativeClientVSAddIn.Connect.#ctor">
|
| + <summary>Implements the constructor for the Add-in object. Place your initialization code within this method.</summary>
|
| + </member>
|
| + <member name="M:NativeClientVSAddIn.Connect.OnConnection(System.Object,Extensibility.ext_ConnectMode,System.Object,System.Array@)">
|
| + <summary>Implements the OnConnection method of the IDTExtensibility2 interface. Receives notification that the Add-in is being loaded.</summary>
|
| + <param term='application'>Root object of the host application.</param>
|
| + <param term='connectMode'>Describes how the Add-in is being loaded.</param>
|
| + <param term='addInInst'>Object representing this Add-in.</param>
|
| + <seealso class='IDTExtensibility2' />
|
| + </member>
|
| + <member name="M:NativeClientVSAddIn.Connect.DebuggerOnEnterDesignMode(EnvDTE.dbgEventReason)">
|
| + <summary>
|
| + Called when Visual Studio ends a debugging session
|
| + </summary>
|
| + <param name="reason"></param>
|
| + </member>
|
| + <member name="M:NativeClientVSAddIn.Connect.DebuggerOnEnterRunMode(EnvDTE.dbgEventReason)">
|
| + <summary>
|
| + Called when Visual Studio starts a debugging session
|
| + </summary>
|
| + <param name="reason"></param>
|
| + </member>
|
| + <member name="M:NativeClientVSAddIn.Connect.OnDisconnection(Extensibility.ext_DisconnectMode,System.Array@)">
|
| + <summary>Implements the OnDisconnection method of the IDTExtensibility2 interface. Receives notification that the Add-in is being unloaded.</summary>
|
| + <param term='disconnectMode'>Describes how the Add-in is being unloaded.</param>
|
| + <param term='custom'>Array of parameters that are host application specific.</param>
|
| + <seealso class='IDTExtensibility2' />
|
| + </member>
|
| + <member name="M:NativeClientVSAddIn.Connect.OnAddInsUpdate(System.Array@)">
|
| + <summary>Implements the OnAddInsUpdate method of the IDTExtensibility2 interface. Receives notification when the collection of Add-ins has changed.</summary>
|
| + <param term='custom'>Array of parameters that are host application specific.</param>
|
| + <seealso class='IDTExtensibility2' />
|
| + </member>
|
| + <member name="M:NativeClientVSAddIn.Connect.OnStartupComplete(System.Array@)">
|
| + <summary>Implements the OnStartupComplete method of the IDTExtensibility2 interface. Receives notification that the host application has completed loading.</summary>
|
| + <param term='custom'>Array of parameters that are host application specific.</param>
|
| + <seealso class='IDTExtensibility2' />
|
| + </member>
|
| + <member name="M:NativeClientVSAddIn.Connect.OnBeginShutdown(System.Array@)">
|
| + <summary>Implements the OnBeginShutdown method of the IDTExtensibility2 interface. Receives notification that the host application is being unloaded.</summary>
|
| + <param term='custom'>Array of parameters that are host application specific.</param>
|
| + <seealso class='IDTExtensibility2' />
|
| + </member>
|
| + <member name="M:NativeClientVSAddIn.Connect.IsNativeClientSolution">
|
| + <summary>
|
| + Tells us if this add-in is applicable within this solution
|
| + </summary>
|
| + <returns>True if this add-in is applicable to this solution</returns>
|
| + </member>
|
| + <member name="T:NativeClientVSAddIn.PluginDebuggerHelper">
|
| + <summary>
|
| + This class contains functions and utilities which are run when the user
|
| + "presses F5" or otherwise starts debugging from within Visual Studio.
|
| + </summary>
|
| + </member>
|
| + <member name="M:NativeClientVSAddIn.PluginDebuggerHelper.#ctor(EnvDTE80.DTE2)">
|
| + <summary>
|
| + Constructs the PluginDebuggerHelper. Object is not useable until InitializeFromProjectSettings() is called
|
| + </summary>
|
| + <param name="dte">Automation object from Visual Studio</param>
|
| + </member>
|
| + <member name="M:NativeClientVSAddIn.PluginDebuggerHelper.InitializeFromProjectSettings">
|
| + <summary>
|
| + Initializes the PluginDebuggerHelper with the current project settings
|
| + If project settings are unsupported for NaCl/Pepper debugging then
|
| + the object is not initialized and we return false
|
| + </summary>
|
| + <returns>True if the object is successfully initialized, false otherwise</returns>
|
| + </member>
|
| + <member name="M:NativeClientVSAddIn.PluginDebuggerHelper.StartDebugging">
|
| + <summary>
|
| + This function should be called to start the PluginDebuggerHelper functionality
|
| + </summary>
|
| + </member>
|
| + <member name="M:NativeClientVSAddIn.PluginDebuggerHelper.StopDebugging">
|
| + <summary>
|
| + This function should be called to stop the PluginDebuggerHelper functionality
|
| + </summary>
|
| + </member>
|
| + <member name="M:NativeClientVSAddIn.PluginDebuggerHelper.KillGDBProcess">
|
| + <summary>
|
| + Calling this will clean up the started GDB process
|
| + </summary>
|
| + </member>
|
| + <member name="M:NativeClientVSAddIn.PluginDebuggerHelper.FindAndAttachToPlugin(System.Object,System.EventArgs)">
|
| + <summary>
|
| + Called periodically by the Visual Studio UI thread to look for our plug-in process
|
| + and attach the debugger to it. The call is triggered by the _pluginFinderTimer object
|
| + </summary>
|
| + <param name="unused">Unused</param>
|
| + <param name="unused1">Unused</param>
|
| + </member>
|
| + <member name="M:NativeClientVSAddIn.PluginDebuggerHelper.AttachVSDebugger(System.Object,NativeClientVSAddIn.PluginFoundEventArgs)">
|
| + <summary>
|
| + Attaches the visual studio debugger to a given process ID
|
| + </summary>
|
| + <param name="src">Object the event came from</param>
|
| + <param name="args">Contains the process ID to attach to</param>
|
| + </member>
|
| + <member name="M:NativeClientVSAddIn.PluginDebuggerHelper.AttachNaClGDB(System.Object,NativeClientVSAddIn.PluginFoundEventArgs)">
|
| + <summary>
|
| + Will do magic to attach GDB to NaCl process properly, load symbols, and load breakpoints
|
| + </summary>
|
| + <param name="src">Object the event came from</param>
|
| + <param name="args">Contains the process ID to attach to, unused since debug stub already attached</param>
|
| + </member>
|
| + <member name="M:NativeClientVSAddIn.PluginDebuggerHelper.StartWebServer">
|
| + <summary>
|
| + Spins up the web server process to host our plugin
|
| + </summary>
|
| + </member>
|
| + <member name="M:NativeClientVSAddIn.PluginDebuggerHelper.WebServerMessageReceive(System.Object,System.Diagnostics.DataReceivedEventArgs)">
|
| + <summary>
|
| + Receives output from the web server process to display in the Visual Studio UI
|
| + </summary>
|
| + <param name="sender">Unused</param>
|
| + <param name="e">Contains the data to display</param>
|
| + </member>
|
| + <member name="M:NativeClientVSAddIn.PluginDebuggerHelper.WebServerWriteLine(System.String)">
|
| + <summary>
|
| + Helper function to write data to the Web Server Output Pane
|
| + </summary>
|
| + <param name="message">Message to write</param>
|
| + </member>
|
| + <member name="P:NativeClientVSAddIn.PluginDebuggerHelper.IsDebuggerRunning">
|
| + <summary>
|
| + Indicates true if the debugger is running (even during breakpoints)
|
| + </summary>
|
| + </member>
|
| + <member name="T:NativeClientVSAddIn.PluginDebuggerHelper.DebuggerType">
|
| + <summary>
|
| + Specifies the debugger to use when debugging
|
| + </summary>
|
| + </member>
|
| + <member name="T:NativeClientVSAddIn.PluginDebuggerHelper.ProjectPlatformType">
|
| + <summary>
|
| + Specifies the type of plug-in being run in this debug session
|
| + </summary>
|
| + </member>
|
| + <member name="T:NativeClientVSAddIn.PluginFoundEventArgs">
|
| + <summary>
|
| + The event arguments when a plug-in is found
|
| + </summary>
|
| + </member>
|
| + <member name="T:NativeClientVSAddIn.Strings">
|
| + <summary>
|
| + A strongly-typed resource class, for looking up localized strings, etc.
|
| + </summary>
|
| + </member>
|
| + <member name="P:NativeClientVSAddIn.Strings.ResourceManager">
|
| + <summary>
|
| + Returns the cached ResourceManager instance used by this class.
|
| + </summary>
|
| + </member>
|
| + <member name="P:NativeClientVSAddIn.Strings.Culture">
|
| + <summary>
|
| + Overrides the current thread's CurrentUICulture property for all
|
| + resource lookups using this strongly typed resource class.
|
| + </summary>
|
| + </member>
|
| + <member name="P:NativeClientVSAddIn.Strings.ChromePathEnvironmentVariable">
|
| + <summary>
|
| + Looks up a localized string similar to CHROME_PATH.
|
| + </summary>
|
| + </member>
|
| + <member name="P:NativeClientVSAddIn.Strings.NaClDebugFlag">
|
| + <summary>
|
| + Looks up a localized string similar to --enable-nacl-debug.
|
| + </summary>
|
| + </member>
|
| + <member name="P:NativeClientVSAddIn.Strings.NaClPlatformName">
|
| + <summary>
|
| + Looks up a localized string similar to NaCl.
|
| + </summary>
|
| + </member>
|
| + <member name="P:NativeClientVSAddIn.Strings.NaClProcessName">
|
| + <summary>
|
| + Looks up a localized string similar to nacl64.exe.
|
| + </summary>
|
| + </member>
|
| + <member name="P:NativeClientVSAddIn.Strings.NaClProcessTypeFlag">
|
| + <summary>
|
| + Looks up a localized string similar to --type=nacl-loader.
|
| + </summary>
|
| + </member>
|
| + <member name="P:NativeClientVSAddIn.Strings.PepperPlatformName">
|
| + <summary>
|
| + Looks up a localized string similar to PPAPI.
|
| + </summary>
|
| + </member>
|
| + <member name="P:NativeClientVSAddIn.Strings.PepperProcessName">
|
| + <summary>
|
| + Looks up a localized string similar to chrome.exe.
|
| + </summary>
|
| + </member>
|
| + <member name="P:NativeClientVSAddIn.Strings.PepperProcessPluginFlagFormat">
|
| + <summary>
|
| + Looks up a localized string similar to --register-pepper-plugins="{0};application/x-nacl".
|
| + </summary>
|
| + </member>
|
| + <member name="P:NativeClientVSAddIn.Strings.PepperProcessTypeFlag">
|
| + <summary>
|
| + Looks up a localized string similar to --type=renderer.
|
| + </summary>
|
| + </member>
|
| + <member name="P:NativeClientVSAddIn.Strings.SDKPathEnvironmentVariable">
|
| + <summary>
|
| + Looks up a localized string similar to NACL_SDK_ROOT.
|
| + </summary>
|
| + </member>
|
| + <member name="P:NativeClientVSAddIn.Strings.WebServerMultiStartProjectWarning">
|
| + <summary>
|
| + Looks up a localized string similar to Warning: Multiple start-up projects not supported. Web server will only be run from first project directory.
|
| + </summary>
|
| + </member>
|
| + <member name="P:NativeClientVSAddIn.Strings.WebServerOutputWindowTitle">
|
| + <summary>
|
| + Looks up a localized string similar to Native Client Web Server Output.
|
| + </summary>
|
| + </member>
|
| + <member name="P:NativeClientVSAddIn.Strings.WebServerStartFail">
|
| + <summary>
|
| + Looks up a localized string similar to Warning: Failed to start web server. Is python.exe on the path? Is httpd.py in the plug-in project folder?.
|
| + </summary>
|
| + </member>
|
| + <member name="P:NativeClientVSAddIn.Strings.WebServerStartMessage">
|
| + <summary>
|
| + Looks up a localized string similar to Launching web server....
|
| + </summary>
|
| + </member>
|
| + <member name="T:NativeClientVSAddIn.ProcessInfo">
|
| + <summary>
|
| + Holds information about a process
|
| + </summary>
|
| + </member>
|
| + <member name="T:NativeClientVSAddIn.Utility">
|
| + <summary>
|
| + Contains helper functions for this add-in
|
| + </summary>
|
| + </member>
|
| + <member name="M:NativeClientVSAddIn.Utility.IsVisualCProject(EnvDTE.Project)">
|
| + <summary>
|
| + Tells us if the given project is a Visual C/C++ project
|
| + </summary>
|
| + <param name="proj">Project to check</param>
|
| + <returns>True if project is a Visual C/C++ project</returns>
|
| + </member>
|
| + <member name="M:NativeClientVSAddIn.Utility.GetActiveVCConfiguration(EnvDTE.Project)">
|
| + <summary>
|
| + Given a generic project, checks that it is a Visual C project, and extracts
|
| + the active VCConfiguration object
|
| + </summary>
|
| + <param name="proj">Generic project object, will return null if not VCProject</param>
|
| + <returns>The active configuration as a VCConfiguration object, or null if failure</returns>
|
| + </member>
|
| + <member name="M:NativeClientVSAddIn.Utility.IsDescendantOfProcess(NativeClientVSAddIn.IProcessSearcher,System.UInt32,System.UInt32)">
|
| + <summary>
|
| + Checks if the first argument is a descendant of the second, where
|
| + both arguments are process IDs of two processes.
|
| + </summary>
|
| + <param name="processSearcher">Process searcher object</param>
|
| + <param name="descendant">Process ID of the descendant</param>
|
| + <param name="ancestor">Process ID of ancestor</param>
|
| + <returns>True if descendant is a descendant of ancestor</returns>
|
| + </member>
|
| + <member name="M:NativeClientVSAddIn.Utility.IsDescendantOfProcessHelper(NativeClientVSAddIn.IProcessSearcher,System.UInt32,System.UInt32,System.DateTime)">
|
| + <summary>
|
| + Helper function for IsDescendantOfProcessHelper
|
| + This function prevents an edge case where a process has a parent process ID
|
| + that refers to a descendant of itself. This can occur when the parent of a process
|
| + is destroyed and the parent's pid is recycled and reused on a descendant. The
|
| + parent process ID value is never updated when the parent is destroyed. The solution
|
| + is to ensure that parents are created before children.
|
| + </summary>
|
| + <param name="processSearcher">Process searcher object</param>
|
| + <param name="descendant">Process ID of the descendant</param>
|
| + <param name="anscestor">Process ID of the ancestor</param>
|
| + <param name="previousCreationTime">Creation time of the previous call's descendant</param>
|
| + <returns>True if descendant is a descendant of ancestor</returns>
|
| + </member>
|
| + </members>
|
| +</doc>
|
|
|