From 463f4365a5944697e2595f286981fc5954b26ee2 Mon Sep 17 00:00:00 2001 From: VerzatileDev <47317248+VerzatileDev@users.noreply.github.com> Date: Sun, 14 Jan 2024 23:59:31 +0200 Subject: [PATCH 1/5] Back To Top True/False In the following Update back to top feature under each page's footer can now be changed to not be included by using the following command " back_to_top: false ", where as it is by default controlled globally, the default value in config has now moved to the Default.html itself so that in the feature different templates can be used. --- _config.yml | 4 +--- _includes/components/footer.html | 8 ++++---- _layouts/default.html | 1 + index.md | 1 + 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/_config.yml b/_config.yml index a38c180..3c46c64 100644 --- a/_config.yml +++ b/_config.yml @@ -9,11 +9,9 @@ github_base_url: "https://github.com/VerzatileDevOrg/Programming_HandBook" aux_links: Contribute to the Github Repository: https://github.com/VerzatileDevOrg/Programming_HandBook -back_to_top: true # Works through Footer.html - plugins: - jekyll-last-modified-at # Optional. The default date format, used if none is specified in the tag. last-modified-at: - date-format: '%d/%m/%Y' + date-format: '%d/%m/%Y' \ No newline at end of file diff --git a/_includes/components/footer.html b/_includes/components/footer.html index e9629bc..81af327 100644 --- a/_includes/components/footer.html +++ b/_includes/components/footer.html @@ -1,10 +1,10 @@
- {% if site.back_to_top %} -

- Back to Top -

+ {% if page.back_to_top != false %} +

+ Back to Top +

{% endif %}
diff --git a/_layouts/default.html b/_layouts/default.html index e862d88..8b1f465 100644 --- a/_layouts/default.html +++ b/_layouts/default.html @@ -1,6 +1,7 @@ --- layout: table_wrappers include_language_switch_script: false +back_to_top: true --- diff --git a/index.md b/index.md index 0bf747e..8165601 100644 --- a/index.md +++ b/index.md @@ -3,6 +3,7 @@ title: Home layout: default nav_order: 1 has_children: false +back_to_top: false --- ## About From be43fe4f481bc39d6f8cf72b31ed732d03bf295d Mon Sep 17 00:00:00 2001 From: VerzatileDev <47317248+VerzatileDev@users.noreply.github.com> Date: Mon, 15 Jan 2024 16:52:05 +0200 Subject: [PATCH 2/5] Visual Update to Collections/Code Collections are now documented and organized specific to the Light theme of the current website, using Hex Color scheme, and titles can now be specified manually for each collection by the use of : {: .collection title="NewTitle"} if it is not defined the specified collection uses the default written title which is based on the name of itself. Note that collection Title can be written as empty as well if there is not a requirement to display it! Just use : title= "" instead. Made Adjustments within Code.scss, where each code block would not display a box-shadow around itself, as well as on the left side of it use a border colour. --- _sass/code.scss | 3 +- _sass/custom/collections.scss | 234 +++++++++++++++++++++++++--------- 2 files changed, 178 insertions(+), 59 deletions(-) diff --git a/_sass/code.scss b/_sass/code.scss index 949f6f8..6b6d11a 100644 --- a/_sass/code.scss +++ b/_sass/code.scss @@ -36,10 +36,11 @@ margin-bottom: $sp-3; background-color: $code-background-color; border-radius: $border-radius; - box-shadow: none; + box-shadow: 0 0 10px rgba(0, 0, 0, 0.3); -webkit-overflow-scrolling: touch; position: relative; padding: 10px; + border-left: 4px solid purple; // copy button (or other button) // the button appear only when there is a hover on the code or focus on button diff --git a/_sass/custom/collections.scss b/_sass/custom/collections.scss index 58e749f..7b5e89e 100644 --- a/_sass/custom/collections.scss +++ b/_sass/custom/collections.scss @@ -1,86 +1,171 @@ -// Callout Tags "Will make a box content with a background colour, side and Title -// Callouts should be Added into a seperate Style When possible! +/// Future Developers - Please Take notice of Following: +/// Collections must be Represented as ::Before :not .collection +/// .warning::before , .warning:not , .warning +/// +/// Aim to use Hex Color scheme fo Background, Fonts and other sections. +/// To assure global viability of each browser. +/// Please Seperate new Collections by two Lines +/// Bracket endings with a line +/// +/// Functionalities modifiable:: +/// - content of each collection can be changed by using {: . ... title="NewTitle"} +/// For each collection, and should as well be used for any future ones represented. +/// +/// TO DO: Assign Coloring On the basis of the Webs Current Theme such as Dark of Light! + +// -------------COLLECTIONS-----------------// + +// --- WARNING ---- +// Use the following specifically to give out attention to some important notice or issue that may be occured or changed. +// The current one makes a Box, with either a Default or manual written Title top box +// Then a bottom box for the content that would be displayed under {: .warning } content.. +.warning::before { + content: attr(title); + color: #ffffff; + background-color: #f0b37e; + margin: -15px -15px 15px; + display: block; + font-weight: bold; + font-size: 1.00em; + padding-bottom: 0.125rem; + padding: 6px 12px; + border-radius: 6px; +} + +// If a specified Title is not defined by {: .warning title="newAWesomeTitle"}, then use default title, can also be empty! +.warning:not([title])::before { + content: "Warning !"; +} + .warning { position: relative; - border-radius: 5px; - background-color: rgb(154 132 17/ 80%); - border-left: 4px solid #e7af06; + border-radius: 6px; + background-color: #FFEDCB; padding: 0.8rem; left: 5px; - color: rgba(255, 255, 255); /* Set the text color inside the .warning element to white */ - } - -.warning::before { - content: "Warning!"; - color: #f0ff00; + color: #404040; + box-shadow: 0 0 10px rgba(0, 0, 0, 0.3); +} + + +// --- ISSUE ---- +// Use this specify a problem with the specified content or example, can be used for other contexts. +// Generates a Title element without a box at the top of the content written after {: .issue } content.. +.issue::before { + content: attr(title); + color: #ffffff; + background-color: #f07e7e; + margin: -15px -15px 15px; display: block; font-weight: bold; - text-transform: uppercase; - font-size: 0.75em; + font-size: 1.00em; padding-bottom: 0.125rem; + padding: 6px 12px; + border-radius: 6px; } - -.important { - background: rgb(255 125 125 / 20%); - border-left: 4px solid #dd2e2e; + +// If a specified Title is not defined by {: .note title="newAWesomeTitle"}, then use default title, can also be used as "" Empty. +.issue:not([title])::before { + content: "Issue !"; +} + +.issue { + background: #ff7d7d33; border-radius: 4px; padding: 0.8rem; + left: 5px; + box-shadow: 0 0 10px rgba(0, 0, 0, 0.3); } - -.important::before { - color: #dd2e2e; - content: "Important!"; + + +// --- NEW --- +// Use this to specify new Updates, changes to code, documentation, versions etc. +// Generates a Title element without a box at the top of the content written after {: .new } content.. +.new::before { + content: attr(title); + color: #ffffff; display: block; + background-color: #1abc9c; font-weight: bold; - text-transform: uppercase; - font-size: 0.75em; + font-size: 1.00em; padding-bottom: 0.125rem; + margin: -15px -15px 15px; + padding: 6px 12px; + border-radius: 6px; } - -.information { - background: rgba(44, 132, 250, 0.2); - border-left: 4px solid #183385; + +// If a specified Title is not defined by {: .note title="newAWesomeTitle"}, then use default title, can also be used as "" Empty. +.new:not([title])::before { + content: "New !"; +} + +.new { + background: #e7f2fa; border-radius: 4px; padding: 0.8rem; + box-shadow: 0 0 10px rgba(0, 0, 0, 0.3); } - -.information::before { - content: "Information:"; - color: #183385; + +// ----IMPORTANT------- +// Use this to specify an important resource of context before using the given content, or use this as a reminder to the reader what they +// should keep in mind with the given information, etc. +// Generates a Title elements without a box at the top of the content written after {: .important } content.. +.important::before { + content: attr(title); + color: #dd2e2e; display: block; font-weight: bold; text-transform: uppercase; font-size: 0.75em; padding-bottom: 0.125rem; } - -.issue { + +// If a specified Title is not defined by {: .important title="newAWesomeTitle"}, then use default title, can also be used as "" Empty. +.important:not([title])::before { + content: "Important!"; +} + +.important { background: rgb(255 125 125 / 20%); border-left: 4px solid #dd2e2e; border-radius: 4px; padding: 0.8rem; + box-shadow: 0 0 10px rgba(0, 0, 0, 0.3); } - -.issue::before { - content: "Issue:"; - color: #dd2e2e; + +// ----NOTE---- +// Use this to specify some context that the reader should focus on for the given changes or content that should be read before continuing +// Can as well be used to specify any other important context, that the reader should take of notice. +// Generates a Title element without a box at the top of the content written after {: .note } content.. +.note::before { + content: attr(title); + color: #183385; display: block; font-weight: bold; text-transform: uppercase; font-size: 0.75em; padding-bottom: 0.125rem; } - -.further-reading { - background: rgba(114, 83, 237, 0.2); - border-left: 4px solid #381885; + +// If a specified Title is not defined by {: .note title="newAWesomeTitle"}, then use default title, can also be used as "" Empty. +.note:not([title])::before { + content: "Note:"; +} + +.note { + background: rgba(44, 132, 250, 0.2); + border-left: 4px solid #183385; border-radius: 4px; padding: 0.8rem; - color: rgb(255 255 255); + box-shadow: 0 0 10px rgba(0, 0, 0, 0.3); } - + + +// --- FURTHER READING ---- +// Additional context to the given content, what the reader could read to better understand the given text. +// Generates a Title element without a box at the top of the content written after {: .further-reading } content.. .further-reading::before { - content: "Further Reading:"; + content: attr(title); color: #381885; display: block; font-weight: bold; @@ -89,30 +174,29 @@ padding-bottom: 0.125rem; } -.new { - background: rgba(65, 214, 147, 0.2); - border-left: 4px solid #026e57; +// If a specified Title is not defined by {: .note title="newAWesomeTitle"}, then use default title, can also be used as "" Empty. +.further-reading:not([title])::before { + content: "Further Reading:"; +} + +.further-reading { + background: rgba(114, 83, 237, 0.2); + border-left: 4px solid #381885; border-radius: 4px; padding: 0.8rem; - color: rgb(255 255 255); + box-shadow: 0 0 10px rgba(0, 0, 0, 0.3); } -.new::before { - color: #06ffca; - content: "New"; - display: block; - font-weight: bold; - text-transform: uppercase; - font-size: 0.75em; - padding-bottom: 0.125rem; -} +// --- EXAMPLE --- +// Specify and use the following to explain a section of the content use cases +// Generates a Title element without a box at the top of the content written after {: .new } content.. .example { position: relative; border-radius: 5px; background: rgba(114, 83, 237, 0.2); - border-left: 4px solid purple; padding: 0.8rem; + box-shadow: 0 0 10px rgba(0, 0, 0, 0.3); } .example::before { @@ -123,4 +207,38 @@ text-transform: uppercase; font-size: 0.75em; padding-bottom: 0.125rem; +} + +// If a specified Title is not defined by {: .note title="newAWesomeTitle"}, then use default title, can also be used as "" Empty. +.example:not([title])::before { + content: "Example:"; +} + + +// -----CODE-------- +// Use the following to assign Titles to CodeBlocks +// Alternativly can be used by its own Creating a border on the left of Purple +// Though won't be rendered as a codeblock itself, would be used for Specific 1 line examples +.code::before { + content: attr(title); + color: #381885; + display: block; + font-weight: bold; + text-transform: uppercase; + font-size: 0.75em; + padding-bottom: 0.125rem; +} + +// If a specified Title is not defined by {: .code title="newAWesomeTitle"}, then use default title Code. +.code:not([title])::before { + content: "Code:"; +} + +.code { + position: relative; + padding: 0.8rem; + border-radius: 5px; + border-left: 4px solid #800080; + box-shadow: 0 0 10px rgba(0, 0, 0, 0.3); + background-color: $code-background-color; } \ No newline at end of file From d8845e6141c25cd778bfe205adb58fd761c3c42b Mon Sep 17 00:00:00 2001 From: VerzatileDev <47317248+VerzatileDev@users.noreply.github.com> Date: Mon, 15 Jan 2024 17:05:39 +0200 Subject: [PATCH 3/5] CodeBlock using Specified Collection Tag .Code Addionally change the way code block titles are being handled and made a specified collection tag specifically for it, it can be used with the .highlight system under code.scss or it can be used separately as a standalone example without using the CodeBlock, with the copy button and a few other features. --- docs/Language/C++/Addresses.md | 4 ++-- docs/Language/C++/C++.md | 4 ++-- docs/Language/C++/ConstantPointerToConstant.md | 4 ++-- docs/Language/C++/ConstantPointers.md | 4 ++-- docs/Language/C++/Dereferencing.md | 8 ++++---- docs/Language/C++/MemberPointers.md | 2 +- docs/Language/C++/MultilevelPointers.md | 12 ++++++------ docs/Language/C++/NullPointers.md | 4 ++-- docs/Language/C++/PointerToConstant.md | 4 ++-- docs/Language/C++/Pointers.md | 2 +- docs/Language/C++/RawPointers.md | 4 ++-- docs/Language/C++/References.md | 4 ++-- docs/Language/C++/SmartPointers.md | 4 ++-- docs/Language/C++/VoidPointers.md | 12 ++++++------ 14 files changed, 36 insertions(+), 36 deletions(-) diff --git a/docs/Language/C++/Addresses.md b/docs/Language/C++/Addresses.md index cdd7a04..d1aec6c 100644 --- a/docs/Language/C++/Addresses.md +++ b/docs/Language/C++/Addresses.md @@ -16,7 +16,7 @@ If not, please refer to the [C++](/docs/Language/C++/C++.html) section of this b In C++, the ampersand (`&`) symbol is the address-of operator, used to obtain the memory address of a variable. The memory address represents the location in the computer's memory where the variable is stored. -{: .example } +{: .code} ```cpp int someVar = 69; int* somePtr = &someVar; // Pointer now holds the address of someVar @@ -25,7 +25,7 @@ int value = *somePtr; // Retrieves the value stored at the memory address The memory address is typically represented as a hexadecimal number. -{: .example } +{: .code} ```cpp #include diff --git a/docs/Language/C++/C++.md b/docs/Language/C++/C++.md index c24d280..d77c242 100644 --- a/docs/Language/C++/C++.md +++ b/docs/Language/C++/C++.md @@ -95,7 +95,7 @@ Simply create a new C++ source file (typically with a .cpp extension) using your Here's a simple "Hello, World!" program: -{: .example } +{: .code } ```cpp #include @@ -114,7 +114,7 @@ Save your C++ code with a meaningful filename and the .cpp extension. Use the command-line interface or the IDE to compile your C++ code, using GCC: -{: .example } +{: .code } ```bash g++ your_program.cpp -o your_program ``` diff --git a/docs/Language/C++/ConstantPointerToConstant.md b/docs/Language/C++/ConstantPointerToConstant.md index a15eede..23fabb6 100644 --- a/docs/Language/C++/ConstantPointerToConstant.md +++ b/docs/Language/C++/ConstantPointerToConstant.md @@ -16,7 +16,7 @@ If not, please refer to the [C++](/docs/Language/C++/C++.html) section of this b Constant Pointers To Constants are a C++ pointer type that cannot be used to modify the value it points to, and the pointer itself cannot be reassigned to point to a different memory location. This provides a high level of const-correctness and is often used to indicate that both the pointer and the pointed-to value are constant. -{: .example } +{: .code } ```cpp int someVar = 69; const int* const constPointerToConst = &someVar; @@ -35,7 +35,7 @@ It offers several benefits: - When used in function parameters or class member functions, const pointers to const contribute to designing safer interfaces by indicating that the function/method will not modify the input data. - Allows the compiler to make certain optimizations based on the const-correctness, potentially leading to more efficient code. -{: .example } +{: .code } ```cpp #include diff --git a/docs/Language/C++/ConstantPointers.md b/docs/Language/C++/ConstantPointers.md index ea7840b..31a6daf 100644 --- a/docs/Language/C++/ConstantPointers.md +++ b/docs/Language/C++/ConstantPointers.md @@ -16,7 +16,7 @@ If not, please refer to the [C++](/docs/Language/C++/C++.html) section of this b Constant Pointers are quite straightforward - as with any other standard `const` variable in C++, it's a type of pointer that cannot be reassigned to point to a different memory address. It still allows read-write access to the pointed-to variable though! -{: .example } +{: .code } ```cpp int someVar = 69; int* const constPointer = &someVar; @@ -34,7 +34,7 @@ It offers a few benefits: - When used in function parameters or class member functions, const pointers contribute to designing safer interfaces by indicating that the function/method will not modify the pointer itself, offering const-correctness. - Allows the compiler to make certain optimizations based on const-correctness, potentially leading to more efficient code. -{: .example } +{: .code } ```cpp #include diff --git a/docs/Language/C++/Dereferencing.md b/docs/Language/C++/Dereferencing.md index 8bd6f49..3d5b275 100644 --- a/docs/Language/C++/Dereferencing.md +++ b/docs/Language/C++/Dereferencing.md @@ -16,14 +16,14 @@ If not, please refer to the [C++](/docs/Language/C++/C++.html) section of this b The dereference operator (`*`) is used to access the value at the memory address stored in a pointer. -{: .example } +{: .code } ```cpp int someValue = *somePtr; // Retrieves the value stored at the memory address ``` Dereferencing also allows you to modify the value stored at the memory address. -{: .example } +{: .code } ```cpp int someVar = 420; int* somePtr = &someVar; @@ -32,7 +32,7 @@ int* somePtr = &someVar; When working with pointers to class members, the `->` operator is often used for dereferencing. -{: .example } +{: .code } ```cpp class SomeClass { @@ -47,7 +47,7 @@ ptr->someData = 69; // Dereferencing using the -> operator to access class memb Dereferencing is often combined with pointer arithmetic to manipulate arrays, flags, or other blocks of data. -{: .example } +{: .code } ```cpp int main() { diff --git a/docs/Language/C++/MemberPointers.md b/docs/Language/C++/MemberPointers.md index 4f04226..7ba51dd 100644 --- a/docs/Language/C++/MemberPointers.md +++ b/docs/Language/C++/MemberPointers.md @@ -16,7 +16,7 @@ If not, please refer to the [C++](/docs/Language/C++/C++.html) section of this b Member Pointers are traditional pointers that point to class or struct members. -{: .example } +{: .code } ```cpp class SomeClass { diff --git a/docs/Language/C++/MultilevelPointers.md b/docs/Language/C++/MultilevelPointers.md index 5ae7221..9d8bb23 100644 --- a/docs/Language/C++/MultilevelPointers.md +++ b/docs/Language/C++/MultilevelPointers.md @@ -24,7 +24,7 @@ While these types of pointers provide flexibility, they can make code more error A regular pointer is a single-level pointer, pointing directly to a variable. -{: .example } +{: .code } ```cpp int someVar = 69; int* singlePointer = &someVar; // Single-level pointer @@ -32,7 +32,7 @@ int* singlePointer = &someVar; // Single-level pointer A double-pointer stores the address of another pointer. -{: .example } +{: .code } ```cpp int someVar = 69; int* singlePointer = &someVar; @@ -41,7 +41,7 @@ int** doublePointer = &singlePointer; // Double-level pointer A triple-pointer is a pointer that stores the address of a double-pointer. -{: .example } +{: .code } ```cpp int myValue = 69; int* singlePointer = &someVar; @@ -51,7 +51,7 @@ int*** triplePointer = &doublePointer; // Triple-level pointer Each level of indirection requires an additional dereference to access the actual value that is being pointed to by the pointer "below" it. -{: .example } +{: .code } ```cpp int someVar = 69; int* singlePointer = &someVar; @@ -63,7 +63,7 @@ int value = ***triplePointer; // Accesses the value (69) through triple indirec Multilevel pointers are commonly used in dynamic memory allocation scenarios. -{: .example } +{: .code } ```cpp int*** MakeTriplePointer() { @@ -100,7 +100,7 @@ Multilevel pointers are also useful for handling arrays of pointers or for guard > "There are readability concerns for sure. As for it being a guard, _kind of, I guess?_ The main issue is that the API's are templated, so it is already kind of expecting to return a `float*` or `int*` or whatever, which, in my opinion is totally legit - guarding, like you said. But, if the array is an array of points to BEGIN with, you're left with the `**` nonsense." > _- [@Tom Shinton](www.tomshinton.com), Discussion about Multilevel Pointer use-cases._ -{: .example } +{: .code } ```cpp #include diff --git a/docs/Language/C++/NullPointers.md b/docs/Language/C++/NullPointers.md index e69e602..1361951 100644 --- a/docs/Language/C++/NullPointers.md +++ b/docs/Language/C++/NullPointers.md @@ -18,7 +18,7 @@ If not, please refer to the [C++](/docs/Language/C++/C++.html) section of this b Initializing a pointer without assigning it a specific address sets it to a null pointer. -{: .example } +{: .code } ```cpp int* nullPointer = nullptr; ``` @@ -27,7 +27,7 @@ Note that a `nullptr` is not implicitly convertible to integral types, which hel Checking or Guarding for invalid pointers frequently in your code is good practice, especially when writing critical programs. -{: .example } +{: .code } ```cpp class SomeClass { diff --git a/docs/Language/C++/PointerToConstant.md b/docs/Language/C++/PointerToConstant.md index eccd260..b122797 100644 --- a/docs/Language/C++/PointerToConstant.md +++ b/docs/Language/C++/PointerToConstant.md @@ -16,7 +16,7 @@ If not, please refer to the [C++](/docs/Language/C++/C++.html) section of this b Pointers To Constants in C++ are pointers that can have their memory address reassigned, but cannot be used to modify the value they point to (just like a standard `const` variable). The target is flexible, but the pointed-to value cannot be modified! -{: .example } +{: .code } ```cpp int someVar = 69; const int* pointerToConst = &someVar; @@ -33,7 +33,7 @@ It offers a few benefits: - When used in function parameters or class member functions, a pointer to const indicates that the function/method will not modify the input data, offering safer interfaces. - Allows the compiler to make certain optimizations based on const-correctness, potentially leading to more efficient code. -{: .example } +{: .code } ```cpp #include diff --git a/docs/Language/C++/Pointers.md b/docs/Language/C++/Pointers.md index de99f77..7a6b40e 100644 --- a/docs/Language/C++/Pointers.md +++ b/docs/Language/C++/Pointers.md @@ -20,7 +20,7 @@ In C++, pointers are variables that store references to memory addresses of othe Imagine that pointers are like "signposts" that tell you where an object is in a box, rather than being a copy of the object - when there are several thousand objects floating around, the advantages are clear and can help to ensure operations occur on the correct object reference! -{: .example } +{: .code } ```cpp #include diff --git a/docs/Language/C++/RawPointers.md b/docs/Language/C++/RawPointers.md index e60f5c3..da92f0f 100644 --- a/docs/Language/C++/RawPointers.md +++ b/docs/Language/C++/RawPointers.md @@ -16,7 +16,7 @@ If not, please refer to the [C++](/docs/Language/C++/C++.html) section of this b Raw pointers (`*`) are pointers that directly store the memory address of another variable. They are considered "raw" because they provide a direct and unmanaged interface to memory. -{: .example } +{: .code } ```cpp int* somePtr; // Declaration of an integer pointer ``` @@ -25,7 +25,7 @@ Simple and straightforward to use, they directly represent memory addresses, mak When interacting with C libraries or other languages that don't have the concept of smart pointers, they are also the most compatible option. -{: .example } +{: .code } ```cpp #include diff --git a/docs/Language/C++/References.md b/docs/Language/C++/References.md index 49cbe0c..aac7828 100644 --- a/docs/Language/C++/References.md +++ b/docs/Language/C++/References.md @@ -16,7 +16,7 @@ If not, please refer to the [C++](/docs/Language/C++/C++.html) section of this b While not a pointer type, references are often used in C++ as an alternative to pointers for providing an alias to an existing variable (a way to access that variable through a different name). They must be initialized when declared and cannot be reassigned. -{: .example } +{: .code } ```cpp int someVar = 69; int& someReference = someVar; @@ -32,7 +32,7 @@ References offer some benefits, such as: - References improve code readability by creating expressive and self-documenting code. The use of references indicates that the variable is being referenced or modified within a function. - References are commonly used in operator overloading, allowing you to define custom behaviors for operators like +, -, etc. -{: .example } +{: .code } ```cpp #include diff --git a/docs/Language/C++/SmartPointers.md b/docs/Language/C++/SmartPointers.md index 6990e7f..65a998d 100644 --- a/docs/Language/C++/SmartPointers.md +++ b/docs/Language/C++/SmartPointers.md @@ -29,7 +29,7 @@ Unique pointers (`std::unique_ptr`) represent exclusive ownership of a dynamical Unique pointers enforces exclusive ownership, preventing multiple pointers from managing the same resource simultaneously. -{: .example } +{: .code } ```cpp #include #include @@ -70,7 +70,7 @@ int main() Shared pointers (`std::shared_ptr`) enable shared ownership of a dynamically allocated object. It uses a reference counting mechanism, and the memory is deallocated only when the last shared pointer releases its ownership. It's useful for scenarios where multiple pointers need to share access to the same dynamically allocated object. -{: .example } +{: .code } ```cpp #include #include diff --git a/docs/Language/C++/VoidPointers.md b/docs/Language/C++/VoidPointers.md index 462ec49..9bf6a56 100644 --- a/docs/Language/C++/VoidPointers.md +++ b/docs/Language/C++/VoidPointers.md @@ -16,14 +16,14 @@ If not, please refer to the [C++](/docs/Language/C++/C++.html) section of this b Void pointers `(void*)` are a special type of pointer that can point to objects of any data type. The `void` keyword is used as a placeholder for any data type - it behaves a bit like a templated type (like `T`). Void pointers can be assigned the address of any object. -{: .example } +{: .code } ```cpp void* genericPointer; ``` Of course, void pointers are not type-safe, meaning they do not have information about the type of data they point to. It's the programmer's responsibility to ensure proper casting when using void pointers. -{: .example } +{: .code } ```cpp int integerValue = 69; float floatValue = 4.20; @@ -37,7 +37,7 @@ voidPointer = &floatValue; // Address of a float Void pointers can point to different types during their lifetimes. To use the value pointed to by a void pointer, you need to cast it to the appropriate type. -{: .example } +{: .code } ```cpp #include @@ -59,14 +59,14 @@ int main() Void pointers are often used in dynamic memory allocation functions (`malloc`, `calloc`, `realloc`), which return a void pointer to the allocated memory block. -{: .example } +{: .code } ```cpp void* someDynamicMemory = malloc(sizeof(int)); ``` Void pointers are usually used in functions that need to operate on data of unknown types, where we can't know what could be getting passed around at runtime. -{: .example } +{: .code } ```cpp void genericFunction(void* data, size_t size); ``` @@ -74,7 +74,7 @@ void genericFunction(void* data, size_t size); Void pointers do not provide type information, so improper casting can lead to runtime errors. It's essential to use them carefully and only when necessary, as they may make the code less readable and harder to maintain. In my example below, the type of void pointer is changed from an integer to a float, and even in this simple situation it can get quite difficult to follow. -{: .example } +{: .code } ```cpp #include From ac16523d1e2f44eb02d1339d0204a1e7bc6d9129 Mon Sep 17 00:00:00 2001 From: VerzatileDev <47317248+VerzatileDev@users.noreply.github.com> Date: Mon, 15 Jan 2024 17:09:47 +0200 Subject: [PATCH 4/5] Removal of Under Construction Sign As there is now a specified Warning message, I think the Image is no longer required, and it would as well free up resources, to be less rate-limited in the future (The less Images the better). I think it also changes the Visual appeal of the website to be more lack-luster if left on, with that decision it has now been Removed. --- _includes/under_construction.html | 1 - 1 file changed, 1 deletion(-) diff --git a/_includes/under_construction.html b/_includes/under_construction.html index 6c0d9e2..da4d3ff 100644 --- a/_includes/under_construction.html +++ b/_includes/under_construction.html @@ -1,4 +1,3 @@ -Header
{: .warning } From 84e53bd504bb9a308b1926a03b8f841f51386a01 Mon Sep 17 00:00:00 2001 From: VerzatileDev <47317248+VerzatileDev@users.noreply.github.com> Date: Mon, 15 Jan 2024 17:20:12 +0200 Subject: [PATCH 5/5] Update h1 Page.title font weight 600/padding Previously the Title of the page seemed to look irrelevant, it now has been improved with a considerable change to give it more space from the rest of the content, as well as make it stand out more on what page the reader currently is sat on. --- _sass/custom/custom.scss | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/_sass/custom/custom.scss b/_sass/custom/custom.scss index f17c598..a528b33 100644 --- a/_sass/custom/custom.scss +++ b/_sass/custom/custom.scss @@ -4,6 +4,13 @@ $color-scheme: dark; @import 'collections'; // Collections Boxes for Content @import '../code'; // Overwrites Dependency Values see " Just the Docs " version " Dependency Removed in the future". +// ---- Add these to their specified location, or Get the full file and make changes accordingly --- +// Main Entry (Title of the Page) Accessed by {{ page.title }} +h1 { + padding-bottom: 20px; + font-weight: 600; +} + // All Header 2's have spacing before content h2 { padding-bottom: 20px;