Add more detailed inline documentation

[Jonesy]

Description

Types of changes

Adds improved inline Go documentation to help new developers understand methods and structs as needed, which is prominently displayed via LSPs in editors like Visual Studio Code (see screenshot). This includes the ability to add example code, links to specific files, etc.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Documentation (non-breaking change with enhancements to documentation)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist

• I have checked that unit tests pass locally with my changes
• I have added tests that prove my fix is effective or that my feature works
• I have added necessary documentation (if appropriate)

Further comments

See https://tip.golang.org/doc/comment for further details and examples of other documentation formatting that can be added in subsequent new code added to the repo.