kuser_shared_data all fields documented#25
Conversation
m417z
left a comment
There was a problem hiding this comment.
Thank you for the contribution, looks great! Please address the comments, and fix the typos which aren't false positives.
Co-authored-by: Michael Maltsev <[email protected]>
Co-authored-by: Michael Maltsev <[email protected]>
Co-authored-by: Michael Maltsev <[email protected]>
Co-authored-by: Michael Maltsev <[email protected]>
|
Omg, documentation is hard. You found more flaws than I expected there is 😽. |
|
Yep, but it was fairly minor stuff. It's live now 🎉 A note for future updates: To make it look better on the website, it'd be better to wrap the text (at least the multiline comments) to 106 characters or less. |
|
Perhaps it'd even be better to have it all as markdown text. Then it'd be more convenient to read, responsive to different resolutions, and with formatting. And after all, we have the phnt struct definition on the page with terse documentation already. WDYT? |
|
Excellent! A little bit confusing though that there's a structure with wrong/outdated comments on the page; and then one gotta scroll to the middle of the page to basically the very same structure. That would probably work fine with 99% of structs coz they are usually not that large. Line length of 106 for code blocks is a bit oppressive (imo). Perhaps if monitor horizontal resolution is higher than 800, it would be fine to increase the width of code blocks to accomodate a line length of 120? Regarding markdown... It's a bit complicated. To smuggerly avoid writing a wall of text (esp.since I partially agree), let's say it is easier to copypaste up-to-date, commented structure definition from my internal headers than to maintain additional version in markdown. |
The struct that's displayed by default is from phnt. If they have wrong comments, I'm sure they'll be glad to have them fixed.
Sounds great! |
Documented all fields in KUSER_SHARED_DATA (properly, not the horrible Microsoft slop).
It's actually WIP, as there are some very important sections I want to add very soon (including sync mechanism, kuser in VTL, and links, such as good historical stuff on the subject by Geoff Chappell). But it's better to have bulk of the struct documentation available on NtDoc now.