Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

crypto/aes: documentation missing #29787

Closed
mariecurried opened this issue Jan 17, 2019 · 5 comments
Closed

crypto/aes: documentation missing #29787

mariecurried opened this issue Jan 17, 2019 · 5 comments
Labels
Documentation FrozenDueToAge

Comments

@mariecurried
Copy link

mariecurried commented Jan 17, 2019 •
edited

What did you do?

Hi there.
When I accessed the documentation for the crypto/aes package, I expected to see all the exported functions there.
Instead, only NewCipher and the type KeySizeError are present.

What did you expect to see?

I expected to see all the exported functions in the documentation.

What did you see instead?

Only NewCipher and the type KeySizeError are shown.
@agnivade
Copy link
Contributor

Can you please mention which exported functions are missing ?

@mariecurried
Copy link
Author

The functions I think are lacking documentation are BlockSize, Encrypt and Decrypt.

@agnivade
Copy link
Contributor

I see BlockSize - https://golang.org/pkg/crypto/aes/#pkg-constants.

I don't see any Encrypt and Decrypt functions in the documentation. Even with m=all enabled. - https://golang.org/pkg/crypto/aes/?m=all

@mariecurried
Copy link
Author

Regarding BlockSize, what I meant was the function func (c *aesCipher) BlockSize() int, not the equally-named constant.

@agnivade
Copy link
Contributor

That is not an exported function. The type aesCipher is private. To see all methods, please pass the m=all query parameter as shown above. To see more documentation on the m variable, please see - https://godoc.org/golang.org/x/tools/cmd/godoc.

Closing as there is no bug here.

@golang golang locked and limited conversation to collaborators Jan 17, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Documentation FrozenDueToAge
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@agnivade @gopherbot @mariecurried