+
Skip to content

Added doc comments for all Module.cs files #887

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 10, 2023
Merged

Added doc comments for all Module.cs files #887

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions src/Libs/Adw-1/Public/Module.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,29 @@ public class Module
{
private static bool IsInitialized;

/// <summary>
/// Initialize the <c>Adw</c> module.
/// </summary>
/// <remarks>
/// <para>
/// Calling this method is necessary to correctly initialize the bindings
/// and should be done before using anything else in the <see cref="Adw" />
/// namespace.
/// </para>
/// <para>
/// Calling this method will also initialize the modules this module
/// depends on:
/// </para>
/// <list type="table">
/// <item><description><see cref="Gio.Module" /></description></item>
/// <item><description><see cref="Gtk.Module" /></description></item>
/// </list>
/// <para>
/// If the <see cref="Adw.Application" /> class is used there is no need to
/// call this method, because this module will be implicitly initialized
/// when accessing <see cref="Adw.Application" /> the first time.
/// </para>
/// </remarks>
public static void Initialize()
{
if (IsInitialized)
Expand Down
10 changes: 10 additions & 0 deletions src/Libs/GLib-2.0/Public/Module.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,16 @@ public class Module
{
private static bool IsInitialized;

/// <summary>
/// Initialize the <c>GLib</c> module.
/// </summary>
/// <remarks>
/// <para>
/// Calling this method is necessary to correctly initialize the bindings
/// and should be done before using anything else in the <see cref="GLib" />
/// namespace.
/// </para>
/// </remarks>
public static void Initialize()
{
if (IsInitialized)
Expand Down
17 changes: 17 additions & 0 deletions src/Libs/GObject-2.0/Public/Module.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,23 @@ public class Module
{
private static bool IsInitialized;

/// <summary>
/// Initialize the <c>GObject</c> module.
/// </summary>
/// <remarks>
/// <para>
/// Calling this method is necessary to correctly initialize the bindings
/// and should be done before using anything else in the <see cref="GObject" />
/// namespace.
/// </para>
/// <para>
/// Calling this method will also initialize the modules this module
/// depends on:
/// </para>
/// <list type="table">
/// <item><description><see cref="GLib.Module" /></description></item>
/// </list>
/// </remarks>
public static void Initialize()
{
if (IsInitialized)
Expand Down
21 changes: 21 additions & 0 deletions src/Libs/Gdk-4.0/Public/Module.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,27 @@ public class Module
{
private static bool IsInitialized;

/// <summary>
/// Initialize the <c>Gdk</c> module.
/// </summary>
/// <remarks>
/// <para>
/// Calling this method is necessary to correctly initialize the bindings
/// and should be done before using anything else in the <see cref="Gdk" />
/// namespace.
/// </para>
/// <para>
/// Calling this method will also initialize the modules this module
/// depends on:
/// </para>
/// <list type="table">
/// <item><description><see cref="Cairo.Module" /></description></item>
/// <item><description><see cref="GdkPixbuf.Module" /></description></item>
/// <item><description><see cref="Gio.Module" /></description></item>
/// <item><description><see cref="Pango.Module" /></description></item>
/// <item><description><see cref="PangoCairo.Module" /></description></item>
/// </list>
/// </remarks>
public static void Initialize()
{
if (IsInitialized)
Expand Down
17 changes: 17 additions & 0 deletions src/Libs/GdkPixbuf-2.0/Public/Module.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,23 @@ public class Module
{
private static bool IsInitialized;

/// <summary>
/// Initialize the <c>GdkPixbuf</c> module.
/// </summary>
/// <remarks>
/// <para>
/// Calling this method is necessary to correctly initialize the bindings
/// and should be done before using anything else in the <see cref="GdkPixbuf" />
/// namespace.
/// </para>
/// <para>
/// Calling this method will also initialize the modules this module
/// depends on:
/// </para>
/// <list type="table">
/// <item><description><see cref="Gio.Module" /></description></item>
/// </list>
/// </remarks>
public static void Initialize()
{
if (IsInitialized)
Expand Down
17 changes: 17 additions & 0 deletions src/Libs/Gio-2.0/Public/Module.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,23 @@ public class Module
{
private static bool IsInitialized;

/// <summary>
/// Initialize the <c>Gio</c> module.
/// </summary>
/// <remarks>
/// <para>
/// Calling this method is necessary to correctly initialize the bindings
/// and should be done before using anything else in the <see cref="Gio" />
/// namespace.
/// </para>
/// <para>
/// Calling this method will also initialize the modules this module
/// depends on:
/// </para>
/// <list type="table">
/// <item><description><see cref="GObject.Module" /></description></item>
/// </list>
/// </remarks>
public static void Initialize()
{
if (IsInitialized)
Expand Down
17 changes: 17 additions & 0 deletions src/Libs/Graphene-1.0/Public/Module.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,23 @@ public class Module
{
private static bool IsInitialized;

/// <summary>
/// Initialize the <c>Graphene</c> module.
/// </summary>
/// <remarks>
/// <para>
/// Calling this method is necessary to correctly initialize the bindings
/// and should be done before using anything else in the <see cref="Graphene" />
/// namespace.
/// </para>
/// <para>
/// Calling this method will also initialize the modules this module
/// depends on:
/// </para>
/// <list type="table">
/// <item><description><see cref="GObject.Module" /></description></item>
/// </list>
/// </remarks>
public static void Initialize()
{
if (IsInitialized)
Expand Down
18 changes: 18 additions & 0 deletions src/Libs/Gsk-4.0/Public/Module.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,24 @@ public class Module
{
private static bool IsInitialized;

/// <summary>
/// Initialize the <c>Gsk</c> module.
/// </summary>
/// <remarks>
/// <para>
/// Calling this method is necessary to correctly initialize the bindings
/// and should be done before using anything else in the <see cref="Gsk" />
/// namespace.
/// </para>
/// <para>
/// Calling this method will also initialize the modules this module
/// depends on:
/// </para>
/// <list type="table">
/// <item><description><see cref="Gdk.Module" /></description></item>
/// <item><description><see cref="Graphene.Module" /></description></item>
/// </list>
/// </remarks>
public static void Initialize()
{
if (IsInitialized)
Expand Down
20 changes: 19 additions & 1 deletion src/Libs/Gst-1.0/Public/Module.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,31 @@ public class Module
{
private static bool IsInitialized;

/// <summary>
/// Initialize the <c>Gst</c> module.
/// </summary>
/// <remarks>
/// <para>
/// Calling this method is necessary to correctly initialize the bindings
/// and should be done before using anything else in the <see cref="Gst" />
/// namespace.
/// </para>
/// <para>
/// Calling this method will also initialize the modules this module
/// depends on:
/// </para>
/// <list type="table">
/// <item><description><see cref="GLib.Module" /></description></item>
/// <item><description><see cref="GObject.Module" /></description></item>
/// </list>
/// </remarks>
public static void Initialize()
{
if (IsInitialized)
return;

GObject.Module.Initialize();
GLib.Module.Initialize();
GObject.Module.Initialize();

Internal.ImportResolver.RegisterAsDllImportResolver();
Internal.TypeRegistration.RegisterTypes();
Expand Down
20 changes: 20 additions & 0 deletions src/Libs/GstAudio-1.0/Public/Module.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,26 @@ public class Module
{
private static bool IsInitialized;

/// <summary>
/// Initialize the <c>GstAudio</c> module.
/// </summary>
/// <remarks>
/// <para>
/// Calling this method is necessary to correctly initialize the bindings
/// and should be done before using anything else in the <see cref="GstAudio" />
/// namespace.
/// </para>
/// <para>
/// Calling this method will also initialize the modules this module
/// depends on:
/// </para>
/// <list type="table">
/// <item><description><see cref="GObject.Module" /></description></item>
/// <item><description><see cref="GLib.Module" /></description></item>
/// <item><description><see cref="Gst.Module" /></description></item>
/// <item><description><see cref="GstBase.Module" /></description></item>
/// </list>
/// </remarks>
public static void Initialize()
{
if (IsInitialized)
Expand Down
19 changes: 19 additions & 0 deletions src/Libs/GstBase-1.0/Public/Module.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,25 @@ public class Module
{
private static bool IsInitialized;

/// <summary>
/// Initialize the <c>GstBase</c> module.
/// </summary>
/// <remarks>
/// <para>
/// Calling this method is necessary to correctly initialize the bindings
/// and should be done before using anything else in the <see cref="GstBase" />
/// namespace.
/// </para>
/// <para>
/// Calling this method will also initialize the modules this module
/// depends on:
/// </para>
/// <list type="table">
/// <item><description><see cref="GObject.Module" /></description></item>
/// <item><description><see cref="GLib.Module" /></description></item>
/// <item><description><see cref="Gst.Module" /></description></item>
/// </list>
/// </remarks>
public static void Initialize()
{
if (IsInitialized)
Expand Down
20 changes: 20 additions & 0 deletions src/Libs/GstPbutils-1.0/Public/Module.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,26 @@ public class Module
{
private static bool IsInitialized;

/// <summary>
/// Initialize the <c>GstPbutils</c> module.
/// </summary>
/// <remarks>
/// <para>
/// Calling this method is necessary to correctly initialize the bindings
/// and should be done before using anything else in the <see cref="GstPbutils" />
/// namespace.
/// </para>
/// <para>
/// Calling this method will also initialize the modules this module
/// depends on:
/// </para>
/// <list type="table">
/// <item><description><see cref="Gst.Module" /></description></item>
/// <item><description><see cref="GstBase.Module" /></description></item>
/// <item><description><see cref="GstAudio.Module" /></description></item>
/// <item><description><see cref="GstVideo.Module" /></description></item>
/// </list>
/// </remarks>
public static void Initialize()
{
if (IsInitialized)
Expand Down
18 changes: 18 additions & 0 deletions src/Libs/GstVideo-1.0/Public/Module.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,24 @@ public class Module
{
private static bool IsInitialized;

/// <summary>
/// Initialize the <c>GstVideo</c> module.
/// </summary>
/// <remarks>
/// <para>
/// Calling this method is necessary to correctly initialize the bindings
/// and should be done before using anything else in the <see cref="GstVideo" />
/// namespace.
/// </para>
/// <para>
/// Calling this method will also initialize the modules this module
/// depends on:
/// </para>
/// <list type="table">
/// <item><description><see cref="Gst.Module" /></description></item>
/// <item><description><see cref="GstBase.Module" /></description></item>
/// </list>
/// </remarks>
public static void Initialize()
{
if (IsInitialized)
Expand Down
23 changes: 23 additions & 0 deletions src/Libs/Gtk-4.0/Public/Module.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,29 @@ public class Module
{
private static bool IsInitialized;

/// <summary>
/// Initialize the <c>Gtk</c> module.
/// </summary>
/// <remarks>
/// <para>
/// Calling this method is necessary to correctly initialize the bindings
/// and should be done before using anything else in the <see cref="Gtk" />
/// namespace.
/// </para>
/// <para>
/// Calling this method will also initialize the modules this module
/// depends on:
/// </para>
/// <list type="table">
/// <item><description><see cref="Gdk.Module" /></description></item>
/// <item><description><see cref="Gsk.Module" /></description></item>
/// </list>
/// <para>
/// If the <see cref="Gtk.Application" /> class is used there is no need to
/// call this method, because this module will be implicitly initialized
/// when accessing <see cref="Gtk.Application" /> the first time.
/// </para>
/// </remarks>
public static void Initialize()
{
if (IsInitialized)
Expand Down
17 changes: 17 additions & 0 deletions src/Libs/GtkSource-5/Public/Module.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,23 @@ public class Module
{
private static bool IsInitialized;

/// <summary>
/// Initialize the <c>GtkSource</c> module.
/// </summary>
/// <remarks>
/// <para>
/// Calling this method is necessary to correctly initialize the bindings
/// and should be done before using anything else in the <see cref="GtkSource" />
/// namespace.
/// </para>
/// <para>
/// Calling this method will also initialize the modules this module
/// depends on:
/// </para>
/// <list type="table">
/// <item><description><see cref="Gtk.Module" /></description></item>
/// </list>
/// </remarks>
public static void Initialize()
{
if (IsInitialized)
Expand Down
Loading
点击 这是indexloc提供的php浏览器服务，不要输入任何密码和下载