write code documentation for App-API and IpcMain-API

This commit is contained in:
Gregor Biswanger
2017-10-14 14:41:11 +02:00
parent aa526c4bcb
commit 9848a38b0d
7 changed files with 564 additions and 42 deletions

View File

@@ -1,24 +1,76 @@
using System;
using System.Collections.Generic;
using System.Text;
namespace ElectronNET.API.Entities
namespace ElectronNET.API.Entities
{
public enum PathName
{
/// <summary>
/// User’s home directory.
/// </summary>
home,
/// <summary>
/// Per-user application data directory.
/// </summary>
appData,
/// <summary>
/// The directory for storing your app’s configuration files,
/// which by default it is the appData directory appended with your app’s name.
/// </summary>
userData,
/// <summary>
/// Temporary directory.
/// </summary>
temp,
/// <summary>
/// The current executable file.
/// </summary>
exe,
/// <summary>
/// The libchromiumcontent library.
/// </summary>
module,
/// <summary>
/// The current user’s Desktop directory.
/// </summary>
desktop,
/// <summary>
/// Directory for a user’s “My Documents”.
/// </summary>
documents,
/// <summary>
/// Directory for a user’s downloads.
/// </summary>
downloads,
/// <summary>
/// Directory for a user’s music.
/// </summary>
music,
/// <summary>
/// Directory for a user’s pictures.
/// </summary>
pictures,
/// <summary>
/// Directory for a user’s videos.
/// </summary>
videos,
/// <summary>
///
/// </summary>
logs,
/// <summary>
/// Full path to the system version of the Pepper Flash plugin.
/// </summary>
pepperFlashSystemPlugin
}
}