Updated Library Documentation (markdown)

2025-09-07 11:45:38 +03:00
parent 2700241a65
commit f10914a662

@@ -357,6 +357,7 @@ int main(int argc, char** argv) {
* `std::string pathBasename(std::string_view entry)` - Get the filename part of given path.
* `std::string pathDirname(std::string_view entry)` - Get the directory part of given path.
* `uint64_t getRandomOffset(uint64_t size, uint64_t bufferSize)` - Get random offset depending on size and bufferSize.
* `std::string convertTo(uint64_t size, const std::string &multiple)` - Convert size to multiple. Returns result as string.
---
@@ -487,10 +488,19 @@ for (const auto &entry : myMap) {
- `find(name)`, `find_(name)`: Check existence.
- `size()`, `empty()`: Map size and empty check.
##### Operators
- `operator std::vector<Info>()`: Returns list as vector<Info>.
- `operator int()`: Returns partition count.
- `operator bool()`: Success check.
- `operator!()`: Failure check.
- `operator()(path)`: Build map from path.
- `Info operator[](index)`: Return the information of the section in the input index in the Info structure.
- `BasicInf operator[](name)`: Return the input section name information in the BasicInfo structure.
---
#### BuildMap
Interface to build and query partition maps. `BuildMap` is alias of `basic_partition_map_builder|
Interface to build and query partition maps. `BuildMap` is alias of `basic_partition_map_builder`.
##### Members
- `Map_t _current_map`: Current map.
@@ -521,6 +531,8 @@ Interface to build and query partition maps. `BuildMap` is alias of `basic_parti
- `operator bool()`: Success check.
- `operator!()`: Failure check.
- `operator()(path)`: Build map from path.
- `Info operator[](index)`: Return the information of the section in the input index in the Info structure.
- `BasicInf operator[](name)`: Return the input section name information in the BasicInfo structure.
##### Example Usage