Skip to content

Commit 8daf4d1

Browse files
Todd Schaveyhillin
authored andcommitted
#647 update XML documentation to ElectronNET.API Process members
1 parent c01ef40 commit 8daf4d1

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

src/ElectronNET.API/Process.cs

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,8 @@ public Task<string> TypeAsync
8080

8181

8282
/// <summary>
83-
///
83+
/// The process.versions property returns an object listing the version strings of
84+
/// chrome and electron.
8485
/// </summary>
8586
public Task<Versions> VersionsAsync
8687
{
@@ -93,7 +94,8 @@ public Task<Versions> VersionsAsync
9394

9495

9596
/// <summary>
96-
///
97+
/// A Boolean. When app is started by being passed as parameter to the default app, this
98+
/// property is true in the main process, otherwise it is false.
9799
/// </summary>
98100
public Task<bool> DefaultAppAsync
99101
{
@@ -105,7 +107,8 @@ public Task<bool> DefaultAppAsync
105107
}
106108

107109
/// <summary>
108-
///
110+
/// A Boolean, true when the current renderer context is the "main" renderer frame. If you
111+
/// want the ID of the current frame you should use webFrame.routingId
109112
/// </summary>
110113
public Task<bool> IsMainFrameAsync
111114
{
@@ -117,7 +120,7 @@ public Task<bool> IsMainFrameAsync
117120
}
118121

119122
/// <summary>
120-
///
123+
/// A String representing the path to the resources directory.
121124
/// </summary>
122125
public Task<string> ResourcesPathAsync
123126
{
@@ -129,7 +132,8 @@ public Task<string> ResourcesPathAsync
129132
}
130133

131134
/// <summary>
132-
///
135+
/// The number of seconds the current Node.js process has been running. The return value
136+
/// includes fractions of a second. Use Math.floor() to get whole seconds.
133137
/// </summary>
134138
public Task<double> UpTimeAsync
135139
{
@@ -141,7 +145,7 @@ public Task<double> UpTimeAsync
141145
}
142146

143147
/// <summary>
144-
///
148+
/// The PID of the electron process
145149
/// </summary>
146150
public Task<int> PidAsync
147151
{
@@ -154,7 +158,7 @@ public Task<int> PidAsync
154158

155159

156160
/// <summary>
157-
///
161+
/// The operating system CPU architecture for which the Node.js binary was compiled
158162
/// </summary>
159163
public Task<string> ArchAsync
160164
{
@@ -166,7 +170,7 @@ public Task<string> ArchAsync
166170
}
167171

168172
/// <summary>
169-
///
173+
/// A string identifying the operating system platform on which the Node.js process is running
170174
/// </summary>
171175
public Task<string> PlatformAsync
172176
{

0 commit comments

Comments
 (0)