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. | |
| plg::version | version {} |
| The semantic version of the object. | |
| std::string | versionName |
| The version name of the object. | |
| std::string | friendlyName |
| The friendly name of the object. | |
| std::optional< std::string > | description |
| The description of the object. | |
| std::optional< std::string > | createdBy |
| The creator/author of the object. | |
| std::optional< std::string > | createdByURL |
| The URL of the creator/author. | |
| std::optional< std::string > | docsURL |
| The documentation URL of the object. | |
| std::optional< std::string > | downloadURL |
| The download URL of the object. | |
| std::optional< std::string > | updateURL |
| The update URL of the object. | |
| std::optional< 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)
Definition at line 15 of file descriptor.hpp.
Member Data Documentation
◆ createdBy
| std::optional<std::string> plugify::Descriptor::createdBy |
The creator/author of the object.
Definition at line 21 of file descriptor.hpp.
◆ createdByURL
| std::optional<std::string> plugify::Descriptor::createdByURL |
The URL of the creator/author.
Definition at line 22 of file descriptor.hpp.
◆ description
| std::optional<std::string> plugify::Descriptor::description |
The description of the object.
Definition at line 20 of file descriptor.hpp.
◆ docsURL
| std::optional<std::string> plugify::Descriptor::docsURL |
The documentation URL of the object.
Definition at line 23 of file descriptor.hpp.
◆ downloadURL
| std::optional<std::string> plugify::Descriptor::downloadURL |
The download URL of the object.
Definition at line 24 of file descriptor.hpp.
◆ fileVersion
| int32_t plugify::Descriptor::fileVersion {} |
The file version of the object.
Definition at line 16 of file descriptor.hpp.
◆ friendlyName
| std::string plugify::Descriptor::friendlyName |
The friendly name of the object.
Definition at line 19 of file descriptor.hpp.
◆ resourceDirectories
| std::optional<std::vector<std::string> > plugify::Descriptor::resourceDirectories |
Optional resource directories for the object.
Definition at line 27 of file descriptor.hpp.
◆ supportedPlatforms
| std::optional<std::vector<std::string> > plugify::Descriptor::supportedPlatforms |
The platforms supported by the object.
Definition at line 26 of file descriptor.hpp.
◆ updateURL
| std::optional<std::string> plugify::Descriptor::updateURL |
The update URL of the object.
Definition at line 25 of file descriptor.hpp.
◆ version
| plg::version plugify::Descriptor::version {} |
The semantic version of the object.
Definition at line 17 of file descriptor.hpp.
◆ versionName
| std::string plugify::Descriptor::versionName |
The version name of the object.
Definition at line 18 of file descriptor.hpp.
The documentation for this struct was generated from the following file:
- include/plugify/descriptor.hpp
