cli: Documente la classe Manifest
This commit is contained in:
@@ -6,14 +6,33 @@
|
|||||||
#include <unordered_map>
|
#include <unordered_map>
|
||||||
|
|
||||||
namespace oki {
|
namespace oki {
|
||||||
|
/**
|
||||||
|
* Métadonnées du paquet courant.
|
||||||
|
*/
|
||||||
class Manifest {
|
class Manifest {
|
||||||
private:
|
private:
|
||||||
toml::v3::table table;
|
toml::v3::table table;
|
||||||
toml::v3::table &addDependencySectionIfNotExists();
|
toml::v3::table &addDependencySectionIfNotExists();
|
||||||
|
|
||||||
public:
|
public:
|
||||||
|
/**
|
||||||
|
* Créé un manifeste vide.
|
||||||
|
*/
|
||||||
|
Manifest() = default;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Créé un manifeste à partir d'un fichier existant potentiellement.
|
||||||
|
*/
|
||||||
explicit Manifest(std::filesystem::path fileName);
|
explicit Manifest(std::filesystem::path fileName);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Liste les dépendances directes indiquées dans ce manifeste.
|
||||||
|
*/
|
||||||
std::unordered_map<std::string_view, std::string> listDeclaredPackages() const;
|
std::unordered_map<std::string_view, std::string> listDeclaredPackages() const;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Ajoute un paquet à la liste des dépendances directes. S'il existe déjà, alors il n'est pas rajouté.
|
||||||
|
*/
|
||||||
void addDeclaredPackage(std::string_view packageName, std::string_view version);
|
void addDeclaredPackage(std::string_view packageName, std::string_view version);
|
||||||
friend std::ostream &operator<<(std::ostream &, const Manifest &);
|
friend std::ostream &operator<<(std::ostream &, const Manifest &);
|
||||||
};
|
};
|
||||||
|
Reference in New Issue
Block a user