feat: Add vm/qdoc with function comments

[jefft0]

Addresses #522 (comment)
by adding a query for vm/qdoc that uses a similar code path to gno doc which includes comments.

For example, gnokey query vm/qdoc -data "gno.land/r/demo/boards.CreateRepost" -remote tcp://127.0.0.1:26657 returns

package boards // import "boards"

func CreateRepost(bid BoardID, postid PostID, title string, body string, dstBoardID BoardID) PostID
    If dstBoard is private, does not ping back. If board specified by bid is
    private, panics.

And gnokey query vm/qdoc -data "gno.land/r/demo/boards.Post" -remote tcp://127.0.0.1:26657 returns

package boards // import "boards"

type Post struct {
	// Has unexported fields.
}
    A Post is a "thread" or a "reply" depending on context. A thread is a Post
    of a Board that holds other replies.

func (post *Post) AddReply(creator std.Address, body string) *Post
func (post *Post) AddRepostTo(creator std.Address, title, body string, dst *Board) *Post
func (thread *Post) DeletePost(pid PostID)
func (post *Post) GetDeleteFormURL() string
func (post *Post) GetPostID() PostID
func (thread *Post) GetReply(pid PostID) *Post
func (post *Post) GetReplyFormURL() string
func (post *Post) GetRepostFormURL() string
func (post *Post) GetSummary() string
func (post *Post) GetURL() string
func (post *Post) HasPermission(addr std.Address, perm Permission) bool
func (post *Post) IsThread() bool
func (post *Post) RenderInner() string
func (post *Post) RenderPost(indent string, levels int) string
func (post *Post) RenderSummary() string
func (post *Post) Update(title string, body string)

[Gno2D2]

🛠 PR Checks Summary

🔴 Changes to 'docs' folder must be reviewed/authored by at least one devrel and one tech-staff

Manual Checks (for Reviewers):

• IGNORE the bot requirements for this PR (force green CI check)

Read More

🤖 This bot helps streamline PR reviews by verifying automated checks and providing guidance for contributors and reviewers.

✅ Automated Checks (for Contributors):

🟢 Maintainers must be able to edit this pull request (more info)
🔴 Changes to 'docs' folder must be reviewed/authored by at least one devrel and one tech-staff

☑️ Contributor Actions:

1. Fix any issues flagged by automated checks.
2. Follow the Contributor Checklist to ensure your PR is ready for review.
   • Add new tests, or document why they are unnecessary.
   • Provide clear examples/screenshots, if necessary.
   • Update documentation, if required.
   • Ensure no breaking changes, or include BREAKING CHANGE notes.
   • Link related issues/PRs, where applicable.

☑️ Reviewer Actions:

1. Complete manual checks for the PR, including the guidelines and additional checks if applicable.

📚 Resources:

• Report a bug with the bot.
• View the bot’s configuration file.

Debug

Automated Checks

Maintainers must be able to edit this pull request (more info)

If

🟢 Condition met
└── 🟢 The pull request was created from a fork (head branch repo: jefft0/gno)

Then

🟢 Requirement satisfied
└── 🟢 Maintainer can modify this pull request

Changes to 'docs' folder must be reviewed/authored by at least one devrel and one tech-staff

If

🟢 Condition met
└── 🟢 A changed file matches this pattern: ^docs/ (filename: docs/reference/rpc-endpoints.md)

Then

🔴 Requirement not satisfied
└── 🔴 And
    ├── 🔴 Or
    │   ├── 🔴 Pull request author is a member of the team: tech-staff
    │   └── 🔴 At least 1 user(s) of the team tech-staff approved pull request
    └── 🔴 Or
        ├── 🔴 Pull request author is a member of the team: devrels
        └── 🔴 At least 1 user(s) of the team devrels approved pull request

Manual Checks

**IGNORE** the bot requirements for this PR (force green CI check)

If

🟢 Condition met
└── 🟢 On every pull request

Can be checked by

• Any user with comment edit permission

[codecov]

Codecov Report

Attention: Patch coverage is 23.33333% with 46 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
gno.land/pkg/sdk/vm/keeper.go	0.00%	20 Missing ⚠️
gnovm/pkg/doc/doc.go	0.00%	12 Missing ⚠️
gno.land/pkg/sdk/vm/handler.go	0.00%	11 Missing ⚠️
gnovm/pkg/doc/pkg.go	82.35%	3 Missing ⚠️

📢 Thoughts on this report? Let us know!

[thehowl]

Suggested change

	var rePkgPathAndSymbol = regexp.MustCompile(`^(.+)\.([a-zA-Z0-9_]+)$`)
	var rePkgPathAndSymbol = regexp.MustCompile(`^(.+)(:?\.([a-zA-Z0-9_]+))?$`)

[jefft0]

Hi @thehowl . I see what you're getting at. To match the input "gno.land/r/demo/boards.CreateRepost", we want the first group to be "gno.land/r/demo/boards" and the second group to be "CreateRepost" (or empty if the input doesn't have ".CreateRepost"). Instead, it just lets the second group be optional (empty) and puts the entire input into the first group. I'll try some other variations.

[thehowl]

type JSONDocumentation struct {
	PkgPath string `json:"pkg_path"`
	PackageLine string `json:...` // package io // import "io"
	PackageDoc string // markdown of top-level package documentation
	// https://pkg.go.dev/go/doc#Package.Markdown to render markdown
	
	// These match each of the sections in a pkg.go.dev package documentationj
	Values []JSONValue // constants and variables declared
	Funcs []JSONFunc // ...
	Types []JSONType // ...
}

type JSONFunc struct {
	Name string
	Signature string
	Doc string // markdown
}

cc @alexiscolin @Kouteki to draft an idea for what we want for the frontend.

Ideally, we'd base it off a go package documentation (like io), but also add boxes to retain the functionality of the help page on realm documentation (so we can compose easily gnokey commands from the gnoweb frontend).