GSF: Updated Sandcastle help files to latest version.

J. Ritchie Carroll committed 8 years ago

Commit 5d8dfde1 parent 06a5f733 files · +72 −53Browse files

Unified · Split

3 files

Source/Documentation/AdapterHelp/AdapterHelp.shfbproj +4 −4
Source/Documentation/GridSolutionsFrameworkHelp/GridSolutionsFrameworkHelp.shfbproj +41 −35
Source/Libraries/GSF.Core/Diagnostics/ChildProcessManager.cs +27 −14

Source/Documentation/AdapterHelp/AdapterHelp.shfbproj+4−4

@@ -7,13 +7,13 @@ · 6 unmodified lines
7	7	<Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
8	8	<SchemaVersion>2.0</SchemaVersion>
9	9	<ProjectGuid>92b7fa59-4e8c-4ca8-a2ec-ebcd25aa49d2</ProjectGuid>
10		− <SHFBSchemaVersion>2015.6.5.0</SHFBSchemaVersion>
	10	+ <SHFBSchemaVersion>2017.9.26.0</SHFBSchemaVersion>
11	11	<!-- AssemblyName, Name, and RootNamespace are not used by SHFB but Visual Studio adds them anyway -->
12	12	<AssemblyName>AdapterHelp</AssemblyName>
13	13	<RootNamespace>AdapterHelp</RootNamespace>
14	14	<Name>AdapterHelp</Name>
15	15	<!-- SHFB properties -->
16		− <FrameworkVersion>.NET Framework 4.6</FrameworkVersion>
	16	+ <FrameworkVersion>.NET Framework 4.6.1</FrameworkVersion>
17	17	<OutputPath>..\..\..\Build\Help\Adapters\</OutputPath>
18	18	<HtmlHelpName>GSFTimeSeriesAdapters</HtmlHelpName>
19	19	<Language>en-US</Language>
@@ -81,10 +81,10 @@ · 61 unmodified lines
81	81	<FooterText>See &lt%3ba href=&quot%3bhttps://github.com/GridProtectionAlliance/gsf&quot%3b&gt%3bGrid Solutions Framework Project&lt%3b/a&gt%3b for latest code.</FooterText>
82	82	<FeedbackEMailLinkText>GPA Development</FeedbackEMailLinkText>
83	83	<FeedbackEMailAddress>rcarroll%40gridprotectionalliance.org</FeedbackEMailAddress>
84		− <CopyrightText>Copyright &#169%3b 2017, Grid Protection Alliance. All Rights Reserved.</CopyrightText>
	84	+ <CopyrightText>Copyright &#169%3b 2018, Grid Protection Alliance. All Rights Reserved.</CopyrightText>
85	85	<CopyrightHref>https://www.gridprotectionalliance.org/</CopyrightHref>
86	86	<ContentPlacement>AboveNamespaces</ContentPlacement>
87		− <VisibleItems>Attributes, InheritedMembers, InheritedFrameworkMembers, Protected, ProtectedInternalAsProtected</VisibleItems>
	87	+ <VisibleItems>Attributes, InheritedMembers, InheritedFrameworkMembers, Protected, ProtectedInternalAsProtected, EditorBrowsableNever, NonBrowsable</VisibleItems>
88	88	<ComponentConfigurations>
89	89	<ComponentConfig id="API Token Resolution" enabled="True">
90	90	<component id="API Token Resolution">{@TokenFiles}

Source/Documentation/GridSolutionsFrameworkHelp/GridSolutionsFrameworkHelp.shfbproj+41−35

@@ -7,13 +7,13 @@ · 6 unmodified lines
7	7	<Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
8	8	<SchemaVersion>2.0</SchemaVersion>
9	9	<ProjectGuid>0505f4c3-fcf9-4533-9181-f712889071d8</ProjectGuid>
10		− <SHFBSchemaVersion>2015.6.5.0</SHFBSchemaVersion>
	10	+ <SHFBSchemaVersion>2017.9.26.0</SHFBSchemaVersion>
11	11	<!-- AssemblyName, Name, and RootNamespace are not used by SHFB but Visual Studio adds them anyway -->
12	12	<AssemblyName>GridSolutionsFrameworkHelp</AssemblyName>
13	13	<RootNamespace>GridSolutionsFrameworkHelp</RootNamespace>
14	14	<Name>GridSolutionsFrameworkHelp</Name>
15	15	<!-- SHFB properties -->
16		− <FrameworkVersion>.NET Framework 4.6</FrameworkVersion>
	16	+ <FrameworkVersion>.NET Framework 4.6.1</FrameworkVersion>
17	17	<OutputPath>..\..\..\Build\Help\</OutputPath>
18	18	<HtmlHelpName>GridSolutionsFramework</HtmlHelpName>
19	19	<Language>en-US</Language>
@@ -65,8 +65,9 @@ · 45 unmodified lines
65	65	<MissingTags>AutoDocumentCtors, AutoDocumentDispose</MissingTags>
66	66	<ApiFilter>
67	67	<Filter entryType="Namespace" fullName="GSF.Annotations" isExposed="False" />
68		−<Filter entryType="Namespace" fullName="XamlGeneratedNamespace" isExposed="False" /></ApiFilter>
69		− <VisibleItems>Attributes, InheritedMembers, InheritedFrameworkMembers, Protected, ProtectedInternalAsProtected</VisibleItems>
	68	+ <Filter entryType="Namespace" fullName="XamlGeneratedNamespace" isExposed="False" />
	69	+ </ApiFilter>
	70	+ <VisibleItems>Attributes, InheritedMembers, InheritedFrameworkMembers, Protected, ProtectedInternalAsProtected, EditorBrowsableNever, NonBrowsable</VisibleItems>
70	71	<MaximumGroupParts>2</MaximumGroupParts>
71	72	<NamespaceGrouping>False</NamespaceGrouping>
72	73	<SyntaxFilters>C#, Visual Basic, Managed C++, F#, JavaScript</SyntaxFilters>
@@ -79,7 +80,7 @@ · 6 unmodified lines
79	80	<FooterText>See &lt%3ba href=&quot%3bhttps://github.com/GridProtectionAlliance/gsf/&quot%3b&gt%3bGrid Solutions Framework Project&lt%3b/a&gt%3b for latest code.</FooterText>
80	81	<FeedbackEMailLinkText>GPA Development</FeedbackEMailLinkText>
81	82	<FeedbackEMailAddress>rcarroll%40gridprotectionalliance.org</FeedbackEMailAddress>
82		− <CopyrightText>Copyright &#169%3b 2017, Grid Protection Alliance. All Rights Reserved.</CopyrightText>
	83	+ <CopyrightText>Copyright &#169%3b 2018, Grid Protection Alliance. All Rights Reserved.</CopyrightText>
83	84	<CopyrightHref>https://www.gridprotectionalliance.org/</CopyrightHref>
84	85	<ContentPlacement>AboveNamespaces</ContentPlacement>
85	86	<NamespaceSummaries>
@@ -88,39 +89,44 @@ · 2 unmodified lines
88	89	<ComponentConfigurations>
89	90	<ComponentConfig id="Code Block Component" enabled="True">
90	91	<component id="Code Block Component">
91		− <basePath value="{@HtmlEncProjectFolder}" />
92		− <outputPaths>{@HelpFormatOutputPaths}</outputPaths>
93		− <allowMissingSource value="false" />
94		− <removeRegionMarkers value="false" />
95		− <colorizer syntaxFile="{@SHFBFolder}PresentationStyles\Colorizer\highlight.xml" styleFile="{@SHFBFolder}PresentationStyles\Colorizer\highlight.xsl" stylesheet="{@SHFBFolder}PresentationStyles\Colorizer\highlight.css" scriptFile="{@SHFBFolder}PresentationStyles\Colorizer\highlight.js" disabled="{@DisableCodeBlockComponent}" language="cs" tabSize="0" numberLines="false" outlining="false" keepSeeTags="false" defaultTitle="true" />
96		−</component>
	92	+ <basePath value="{@HtmlEncProjectFolder}" />
	93	+ <outputPaths>{@HelpFormatOutputPaths}</outputPaths>
	94	+ <allowMissingSource value="false" />
	95	+ <removeRegionMarkers value="false" />
	96	+ <colorizer syntaxFile="{@SHFBFolder}PresentationStyles\Colorizer\highlight.xml" styleFile="{@SHFBFolder}PresentationStyles\Colorizer\highlight.xsl" stylesheet="{@SHFBFolder}PresentationStyles\Colorizer\highlight.css" scriptFile="{@SHFBFolder}PresentationStyles\Colorizer\highlight.js" disabled="{@DisableCodeBlockComponent}" language="cs" tabSize="0" numberLines="false" outlining="false" keepSeeTags="false" defaultTitle="true" />
	97	+ </component>
97	98	</ComponentConfig>
98		−<ComponentConfig id="API Token Resolution" enabled="True"><component id="API Token Resolution">{@TokenFiles}
99		−<replace elements="/*//token" item="string(.)" /></component></ComponentConfig>
100		−<ComponentConfig id="Syntax Component" enabled="True"><component id="Syntax Component">
101		− <syntax input="/document/reference" output="/document/syntax" renderReferenceLinks="true" />
102		− <generators>
	99	+ <ComponentConfig id="API Token Resolution" enabled="True">
	100	+ <component id="API Token Resolution">{@TokenFiles}
	101	+<replace elements="/*//token" item="string(.)" /></component>
	102	+ </ComponentConfig>
	103	+ <ComponentConfig id="Syntax Component" enabled="True">
	104	+ <component id="Syntax Component">
	105	+ <syntax input="/document/reference" output="/document/syntax" renderReferenceLinks="true" />
	106	+ <generators>
103	107	{@SyntaxFilters}
104	108	</generators>
105		− <containerElement name="codeSnippetGroup" addNoExampleTabs="true" includeOnSingleSnippets="false" groupingEnabled="{@CodeSnippetGrouping}" />
106		− <configurations>
107		− <generator id="C#" />
108		− <generator id="Visual Basic">
109		− <includeLineContinuation value="false" />
110		− </generator>
111		− <generator id="Visual Basic Usage">
112		− <includeLineContinuation value="false" />
113		− </generator>
114		− <generator id="Managed C++" />
115		− <generator id="F#" />
116		− <generator id="J#" />
117		− <generator id="JScript" />
118		− <generator id="JavaScript" />
119		− <generator id="XAML Usage" />
120		− <generator id="ASP.NET" />
121		− <generator id="X#" />
122		− </configurations>
123		−</component></ComponentConfig></ComponentConfigurations>
	109	+ <containerElement name="codeSnippetGroup" addNoExampleTabs="true" includeOnSingleSnippets="false" groupingEnabled="{@CodeSnippetGrouping}" />
	110	+ <configurations>
	111	+ <generator id="C#" />
	112	+ <generator id="Visual Basic">
	113	+ <includeLineContinuation value="false" />
	114	+ </generator>
	115	+ <generator id="Visual Basic Usage">
	116	+ <includeLineContinuation value="false" />
	117	+ </generator>
	118	+ <generator id="Managed C++" />
	119	+ <generator id="F#" />
	120	+ <generator id="J#" />
	121	+ <generator id="JScript" />
	122	+ <generator id="JavaScript" />
	123	+ <generator id="XAML Usage" />
	124	+ <generator id="ASP.NET" />
	125	+ <generator id="X#" />
	126	+ </configurations>
	127	+ </component>
	128	+ </ComponentConfig>
	129	+ </ComponentConfigurations>
124	130	<HelpFileVersion>2.0.0.0</HelpFileVersion>
125	131	<RootNamespaceTitle>GSF Namespaces</RootNamespaceTitle>
126	132	<SaveComponentCacheCapacity>100</SaveComponentCacheCapacity>

Source/Libraries/GSF.Core/Diagnostics/ChildProcessManager.cs+27−14

@@ -22,6 +22,7 @@ · 21 unmodified lines
22	22	//******************************************************************************************************
23	23
24	24	using System;
	25	+using System.Collections.Generic;
25	26	using System.Diagnostics;
26	27	using System.Runtime.ConstrainedExecution;
27	28	using System.Runtime.InteropServices;
@@ -115,6 +116,7 @@ namespace GSF.Diagnostics · 87 unmodified lines
115	116	}
116	117
117	118	// Fields
	119	+ private List<WeakReference<Process>> m_childProcesses;
118	120	private SafeJobHandle m_jobHandle;
119	121	private bool m_disposed;
120	122
@@ -127,25 +129,33 @@ namespace GSF.Diagnostics · 6 unmodified lines
127	129	/// </summary>
128	130	public ChildProcessManager()
129	131	{
130		− m_jobHandle = new SafeJobHandle(CreateJobObject(IntPtr.Zero, null));
131		−
132		− JOBOBJECT_BASIC_LIMIT_INFORMATION info = new JOBOBJECT_BASIC_LIMIT_INFORMATION
	132	+ if (Common.IsPosixEnvironment)
133	133	{
134		− LimitFlags = 0x2000
135		− };
136		−
137		− JOBOBJECT_EXTENDED_LIMIT_INFORMATION extendedInfo = new JOBOBJECT_EXTENDED_LIMIT_INFORMATION
	134	+ // On non-Windows operating systems we just track associated processes
	135	+ m_childProcesses = new List<WeakReference<Process>>();
	136	+ }
	137	+ else
138	138	{
139		− BasicLimitInformation = info
140		− };
	139	+ m_jobHandle = new SafeJobHandle(CreateJobObject(IntPtr.Zero, null));
141	140
142		− int length = Marshal.SizeOf(typeof(JOBOBJECT_EXTENDED_LIMIT_INFORMATION));
	141	+ JOBOBJECT_BASIC_LIMIT_INFORMATION info = new JOBOBJECT_BASIC_LIMIT_INFORMATION
	142	+ {
	143	+ LimitFlags = 0x2000
	144	+ };
143	145
144		− IntPtr extendedInfoPtr = Marshal.AllocHGlobal(length);
145		− Marshal.StructureToPtr(extendedInfo, extendedInfoPtr, false);
	146	+ JOBOBJECT_EXTENDED_LIMIT_INFORMATION extendedInfo = new JOBOBJECT_EXTENDED_LIMIT_INFORMATION
	147	+ {
	148	+ BasicLimitInformation = info
	149	+ };
146	150
147		− if (!SetInformationJobObject(m_jobHandle, JobObjectInfoType.ExtendedLimitInformation, extendedInfoPtr, (uint)length))
148		− throw new InvalidOperationException($"Unable to set information for ChildProcessManager job. Error: {Marshal.GetLastWin32Error()}");
	151	+ int length = Marshal.SizeOf(typeof(JOBOBJECT_EXTENDED_LIMIT_INFORMATION));
	152	+
	153	+ IntPtr extendedInfoPtr = Marshal.AllocHGlobal(length);
	154	+ Marshal.StructureToPtr(extendedInfo, extendedInfoPtr, false);
	155	+
	156	+ if (!SetInformationJobObject(m_jobHandle, JobObjectInfoType.ExtendedLimitInformation, extendedInfoPtr, (uint)length))
	157	+ throw new InvalidOperationException($"Unable to set information for ChildProcessManager job. Error: {Marshal.GetLastWin32Error()}");
	158	+ }
149	159	}
150	160
151	161	#endregion
@@ -201,13 +211,16 @@ namespace GSF.Diagnostics · 49 unmodified lines
201	211	private static extern IntPtr CreateJobObject(IntPtr hObject, string lpName);
202	212
203	213	[DllImport("kernel32", SetLastError = true)]
	214	+ [return: MarshalAs(UnmanagedType.Bool)]
204	215	private static extern bool SetInformationJobObject(SafeJobHandle jobHandle, JobObjectInfoType infoType, IntPtr lpJobObjectInfo, uint cbJobObjectInfoLength);
205	216
206	217	[DllImport("kernel32", SetLastError = true)]
	218	+ [return: MarshalAs(UnmanagedType.Bool)]
207	219	private static extern bool AssignProcessToJobObject(SafeJobHandle jobHandle, SafeProcessHandle process);
208	220
209	221	[DllImport("kernel32")]
210	222	[ReliabilityContract(Consistency.WillNotCorruptState, Cer.Success)]
	223	+ [return: MarshalAs(UnmanagedType.Bool)]
211	224	private static extern bool CloseHandle(IntPtr hObject);
212	225	// ReSharper restore InconsistentNaming
213	226

GSF: Updated Sandcastle help files to latest version.

Keyboard shortcuts

General

Issues and pull requests

Issues, pull requests and Inbox

Repository code