includes: Added documentation to the rest of the std and hex library

This commit is contained in:
WerWolv
2023-03-26 16:34:06 +02:00
parent 5f352e26d1
commit a9a7f0b186
8 changed files with 293 additions and 1 deletions

View File

@@ -2,8 +2,17 @@
#include <hex/impl/imhex_check.pat>
/*!
Library to allow decoding of more complex values
*/
namespace hex::dec {
/**
Demangles a mangled name into a human readable name
@param mangled_name The mangled name
@return The demangled name
*/
fn demangle(str mangled_name) {
return builtin::hex::dec::demangle(mangled_name);
};

View File

@@ -2,8 +2,17 @@
#include <hex/impl/imhex_check.pat>
/*!
Library to do HTTP requests
*/
namespace hex::http {
/**
Performs a HTTP GET request to the given URL and returns the response body
@param url URL to perform the request to
@return Response body
*/
fn get(str url) {
return builtin::hex::http::get(url);
};

View File

@@ -6,8 +6,15 @@
#include <hex/impl/imhex_check.pat>
#include <hex/dec.pat>
/*!
Types to automatically decode mangled names
*/
namespace hex::type {
/**
A mangled name string that gets demangled when displayed
*/
struct MangledName {
char value[];
} [[sealed, format("hex::type::impl::format_mangled_name")]];