Commit 4d1c1ab5 authored by Daniel P. Berrange's avatar Daniel P. Berrange

Add boilerplate doc headers for all objects

parent 9fcc542c
......@@ -25,6 +25,18 @@
#include "libvirt-sandbox/libvirt-sandbox.h"
/**
* SECTION: libvirt-sandbox-builder-container
* @short_description: Sandbox container construction
* @include: libvirt-sandbox/libvirt-sandbox.h
* @see_also: #GVirSandboxBuilder, #GVirSandboxBuilderMachine
*
* Provides an object for creating sandboxes using container virtualization
*
* The GVirSandboxBuilderContainer object provides a way to builder sandboxes
* using OS container virtualization technologies such as LXC.
*/
#define GVIR_SANDBOX_BUILDER_CONTAINER_GET_PRIVATE(obj) \
(G_TYPE_INSTANCE_GET_PRIVATE((obj), GVIR_SANDBOX_TYPE_BUILDER_CONTAINER, GVirSandboxBuilderContainerPrivate))
......
......@@ -28,6 +28,19 @@
#include "libvirt-sandbox/libvirt-sandbox.h"
/**
* SECTION: libvirt-sandbox-builder-initrd
* @short_description: Kernel ramdisk construction
* @include: libvirt-sandbox/libvirt-sandbox.h
* @see_also: #GVirSandboxBuilderMachine, #GVirSandboxConfigInitrd
*
* Provides an object for constructing kernel ramdisks
*
* The GVirSandboxBuilderInitrd object provides the support
* required to dynically creat minimal footprint kernel
* ramdisks for booting virtual machine based sandboxes.
*/
#define GVIR_SANDBOX_BUILDER_INITRD_GET_PRIVATE(obj) \
(G_TYPE_INSTANCE_GET_PRIVATE((obj), GVIR_SANDBOX_TYPE_BUILDER_INITRD, GVirSandboxBuilderInitrdPrivate))
......
......@@ -26,6 +26,18 @@
#include "libvirt-sandbox/libvirt-sandbox.h"
/**
* SECTION: libvirt-sandbox-builder-machine
* @short_description: Sandbox virtual machine construction
* @include: libvirt-sandbox/libvirt-sandbox.h
* @see_also: #GVirSandboxBuilder, #GVirSandboxBuilderMachine
*
* Provides an object for creating sandboxes using machine virtualization
*
* The GVirSandboxBuilderContainer object provides a way to builder sandboxes
* using full machine virtualization technologies such as KVM.
*/
#define GVIR_SANDBOX_BUILDER_MACHINE_GET_PRIVATE(obj) \
(G_TYPE_INSTANCE_GET_PRIVATE((obj), GVIR_SANDBOX_TYPE_BUILDER_MACHINE, GVirSandboxBuilderMachinePrivate))
......
......@@ -25,6 +25,18 @@
#include "libvirt-sandbox/libvirt-sandbox.h"
/**
* SECTION: libvirt-sandbox-builder
* @short_description: Sandbox construction base class
* @include: libvirt-sandbox/libvirt-sandbox.h
* @see_also: #GVirSandboxBuilderContainer #GVirSandboxBuilderMachine
*
* Provides a base class for constructing sandboxes
*
* The GVirSandboxBuilder objects provides the basic framework for creating
* #GVirDomain instances from #GVirSandboxConfig instances.
*/
#define GVIR_SANDBOX_BUILDER_GET_PRIVATE(obj) \
(G_TYPE_INSTANCE_GET_PRIVATE((obj), GVIR_SANDBOX_TYPE_BUILDER, GVirSandboxBuilderPrivate))
......
......@@ -24,6 +24,19 @@
#include "libvirt-sandbox/libvirt-sandbox.h"
/**
* SECTION: libvirt-sandbox-cleaner
* @short_description: Sandbox context cleanup tasks
* @include: libvirt-sandbox/libvirt-sandbox.h
*
* Provides an object for managing cleanup tasks associated with a sandbox
*
* The GVirSandboxCleaner object provides a framework for registering
* cleanup tasks to be performed at various stages of a sandbox's
* lifecycle. This is typically used to delete temporary files and
* other similar state.
*/
#define GVIR_SANDBOX_CLEANER_GET_PRIVATE(obj) \
(G_TYPE_INSTANCE_GET_PRIVATE((obj), GVIR_SANDBOX_TYPE_CLEANER, GVirSandboxCleanerPrivate))
......
......@@ -25,6 +25,19 @@
#include "libvirt-sandbox/libvirt-sandbox.h"
/**
* SECTION: libvirt-sandbox-config-graphical
* @short_description: Graphical sandbox configuration details
* @include: libvirt-sandbox/libvirt-sandbox.h
* @see_also: #GVirSandboxConfigGraphical
*
* Provides an object to store configuration details for a graphical config
*
* The GVirSandboxConfigGraphical object extends #GVirSandboxConfig to store
* the extra information required to setup a graphical desktop application
* sandbox.
*/
#define GVIR_SANDBOX_CONFIG_GRAPHICAL_GET_PRIVATE(obj) \
(G_TYPE_INSTANCE_GET_PRIVATE((obj), GVIR_SANDBOX_TYPE_CONFIG_GRAPHICAL, GVirSandboxConfigGraphicalPrivate))
......
......@@ -26,6 +26,18 @@
#include "libvirt-sandbox/libvirt-sandbox.h"
/**
* SECTION: libvirt-sandbox-config-initrd
* @short_description: Kernel ramdisk configuration details
* @include: libvirt-sandbox/libvirt-sandbox.h
*
* Provides an object to store information about a kernel ramdisk
*
* The GVirSandboxConfigInitrd object stores the information required
* to build a kernel ramdisk to use when booting a virtual machine
* as a sandbox.
*/
#define GVIR_SANDBOX_CONFIG_INITRD_GET_PRIVATE(obj) \
(G_TYPE_INSTANCE_GET_PRIVATE((obj), GVIR_SANDBOX_TYPE_CONFIG_INITRD, GVirSandboxConfigInitrdPrivate))
......
......@@ -25,6 +25,21 @@
#include "libvirt-sandbox/libvirt-sandbox.h"
/**
* SECTION: libvirt-sandbox-config-mount
* @short_description: Filesystem attachment configuration details
* @include: libvirt-sandbox/libvirt-sandbox.h
* @see_aloso: #GVirSandboxConfig
*
* Provides an object to store information about a filesystem attachment in the sandbox
*
* The GVirSandboxConfigMount object stores information required to attach
* a host filesystem to the application sandbox. The sandbox starts off with
* a complete view of the the host filesystem. This object allows a specific
* area of the host filesystem to be hidden and replaced with alternate
* content.
*/
#define GVIR_SANDBOX_CONFIG_MOUNT_GET_PRIVATE(obj) \
(G_TYPE_INSTANCE_GET_PRIVATE((obj), GVIR_SANDBOX_TYPE_CONFIG_MOUNT, GVirSandboxConfigMountPrivate))
......
......@@ -25,6 +25,18 @@
#include "libvirt-sandbox/libvirt-sandbox.h"
/**
* SECTION: libvirt-sandbox-config
* @short_description: Basic sandbox configuration details
* @include: libvirt-sandbox/libvirt-sandbox.h
* @see_also: #GVirSandboxConfigGraphical
*
* Provides a base object to store configurations for the application sandbox
*
* The GVirSandboxConfig object stores the basic information required to
* create application sandboxes with a simple text based console.
*/
#define GVIR_SANDBOX_CONFIG_GET_PRIVATE(obj) \
(G_TYPE_INSTANCE_GET_PRIVATE((obj), GVIR_SANDBOX_TYPE_CONFIG, GVirSandboxConfigPrivate))
......@@ -665,6 +677,7 @@ void gvir_sandbox_config_set_command(GVirSandboxConfig *config, gchar **argv)
/**
* gvir_sandbox_config_get_command:
* @config: (transfer none): the sandbox config
*
* Retrieve the sandbox command and arguments
*
......
......@@ -31,6 +31,20 @@
#include "libvirt-sandbox/libvirt-sandbox.h"
/**
* SECTION: libvirt-sandbox-console
* @short_description: A text mode console
* @include: libvirt-sandbox/libvirt-sandbox.h
*
* Provides an object to interface to the text mode console of the sandbox
*
* The GVirSandboxConsole object provides support for interfacing to the
* text mode console of the sandbox. It forwards I/O between the #GVirStream
* associated with the virtual machine's console and a local console
* represented by #GUnixInputStream and #GUnixOutputStream objects.
*
*/
#define GVIR_SANDBOX_CONSOLE_GET_PRIVATE(obj) \
(G_TYPE_INSTANCE_GET_PRIVATE((obj), GVIR_SANDBOX_TYPE_CONSOLE, GVirSandboxConsolePrivate))
......
......@@ -25,6 +25,19 @@
#include "libvirt-sandbox/libvirt-sandbox.h"
/**
* SECTION: libvirt-sandbox-context-graphical
* @short_description: Desktop application sandbox context
* @include: libvirt-sandbox/libvirt-sandbox.h
* @see_also: #GVirSandboxContext
*
* Provides a base class for implementing graphical desktop application sandboxes
*
* The GVirSandboxContextGraphical object extends the functionality provided by
* #GVirSandboxContext to allow the application to display output in a graphical
* desktop.
*/
#define GVIR_SANDBOX_CONTEXT_GRAPHICAL_GET_PRIVATE(obj) \
(G_TYPE_INSTANCE_GET_PRIVATE((obj), GVIR_SANDBOX_TYPE_CONTEXT_GRAPHICAL, GVirSandboxContextGraphicalPrivate))
......
......@@ -24,6 +24,20 @@
#include "libvirt-sandbox/libvirt-sandbox.h"
/**
* SECTION: libvirt-sandbox-context
* @short_description: Application sandbox context
* @include: libvirt-sandbox/libvirt-sandbox.h
* @see_also: #GVirSandboxContextGraphical
*
* Provides a base class for implementing console based application sandboxes
*
* The GVirSandboxContext object takes a #GVirSandboxConfig instance, passing it
* to #GVirSandboxBuilder instance to create a virtual machine, and then provides
* access to a #GVirSandboxConsole instance for interacting with the sandboxed
* application's stdio.
*/
#define GVIR_SANDBOX_CONTEXT_GET_PRIVATE(obj) \
(G_TYPE_INSTANCE_GET_PRIVATE((obj), GVIR_SANDBOX_TYPE_CONTEXT, GVirSandboxContextPrivate))
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment