docs: more comments

This commit is contained in:
Martin Prokoph
2025-02-07 15:54:33 +01:00
parent c813274a6c
commit 813e47a25e
10 changed files with 166 additions and 6 deletions

View File

@@ -8,7 +8,17 @@ public:
std::string nameSpace;
std::string path;
Identifier(std::string nameSpace, std::string path) : nameSpace(nameSpace), path(path) {}
/**
* Construct a new Identifier.
* Identifiers are used to uniquely identify blocks, regardless of their encoding.
*
* @param nameSpace The namespace of the Identifier.
* @param path The path of the Identifier.
*/
Identifier(std::string nameSpace, std::string path) : nameSpace(nameSpace), path(path) {
}
std::ostream& operator<<(std::ostream& out) {
out << nameSpace << ":" << path;