Describes the properties of an object. (e.g., module, plugin) More...

#include <descriptor.hpp>

Public Attributes
int32_t	fileVersion {}
	The file version of the object.

int32_t	version {}
	The version number of the object.

std::string	versionName
	The version name of the object.

std::string	friendlyName
	The friendly name of the object.

std::string	description
	The description of the object.

std::string	createdBy
	The creator/author of the object.

std::string	createdByURL
	The URL of the creator/author.

std::string	docsURL
	The documentation URL of the object.

std::string	downloadURL
	The download URL of the object.

std::string	updateURL
	The update URL of the object.

std::vector< std::string >	supportedPlatforms
	The platforms supported by the object.

std::optional< std::vector< std::string > >	resourceDirectories
	Optional resource directories for the object.

Detailed Description

Describes the properties of an object. (e.g., module, plugin)

The Descriptor structure holds information about an object, including file version, version, version name, friendly name, description, creator information, documentation URL, download URL, update URL, and supported platforms.

Definition at line 17 of file descriptor.hpp.

Member Data Documentation

◆ createdBy

std::string plugify::Descriptor::createdBy

The creator/author of the object.

Definition at line 23 of file descriptor.hpp.

◆ createdByURL

std::string plugify::Descriptor::createdByURL

The URL of the creator/author.

Definition at line 24 of file descriptor.hpp.

◆ description

std::string plugify::Descriptor::description

The description of the object.

Definition at line 22 of file descriptor.hpp.

◆ docsURL

std::string plugify::Descriptor::docsURL

The documentation URL of the object.

Definition at line 25 of file descriptor.hpp.

◆ downloadURL

std::string plugify::Descriptor::downloadURL

The download URL of the object.

Definition at line 26 of file descriptor.hpp.

◆ fileVersion

int32_t plugify::Descriptor::fileVersion {}

The file version of the object.

Definition at line 18 of file descriptor.hpp.

◆ friendlyName

std::string plugify::Descriptor::friendlyName

The friendly name of the object.

Definition at line 21 of file descriptor.hpp.

◆ resourceDirectories

std::optional<std::vector<std::string> > plugify::Descriptor::resourceDirectories

Optional resource directories for the object.

Definition at line 29 of file descriptor.hpp.

◆ supportedPlatforms

std::vector<std::string> plugify::Descriptor::supportedPlatforms

The platforms supported by the object.

Definition at line 28 of file descriptor.hpp.

◆ updateURL

std::string plugify::Descriptor::updateURL

The update URL of the object.

Definition at line 27 of file descriptor.hpp.

◆ version

int32_t plugify::Descriptor::version {}

The version number of the object.

Definition at line 19 of file descriptor.hpp.

◆ versionName

std::string plugify::Descriptor::versionName

The version name of the object.

Definition at line 20 of file descriptor.hpp.

The documentation for this struct was generated from the following file:

include/plugify/descriptor.hpp

Public Attributes