diff options
author | Micky <micheledevita2@gmail.com> | 2022-10-10 20:09:56 +0200 |
---|---|---|
committer | Micky <micheledevita2@gmail.com> | 2022-10-18 15:36:18 +0200 |
commit | 474edca10040c79d2a3694d8cbba02a53e4d54b7 (patch) | |
tree | 0dfd824d8d97965f244ddb0170ff1579858cbae1 /drivers/vulkan/vulkan_hooks.h | |
parent | 28f642097a7986867e4fb7d697764efb4db753bf (diff) |
Tweak `@GlobalScope` functions documentation overall
Generally:
- Made use of [param] more frequently;
- Link to other classes' documentation more often;
- Improve and add more examples;
- Ensure that multiple comments of an codeblock example are spaced out equally for better readability;
- Made the writing style closer to how the rest of the documentation is formatted;
- Ensure these are called "functions", not "methods".
- Fixed a few typos.
- Touched up a few cases of zero being written as "zero" or "0" where "0" or "0.0" would be more appropriate.
- Removed mentions of "(real)". In 3.x, this was associated with floats, because TYPE_FLOAT was called TYPE_REAL.
More specifically:
- Every type-safe version of a function (such as `ceili` has a consistent final note ("A type-safe version of [method ceil], returning a [int]").
- Added more details to `randomize`, `seed`.
- Corrected `floori()`'s description. It's not the same as `int()`. This was not correct behavior and has been fixed.
Diffstat (limited to 'drivers/vulkan/vulkan_hooks.h')
0 files changed, 0 insertions, 0 deletions