Add package level doc comment to llvm

This commit is contained in:
Sasha Koshka 2024-02-09 03:35:42 -05:00
parent 92070d142e
commit 74a5527067
1 changed files with 8 additions and 0 deletions

8
llvm/doc.go Normal file
View File

@ -0,0 +1,8 @@
// Package llvm provides a way to build and write out LLVM modules.
//
// This package was created for the express purpose of generating LLVM IR. A
// good portion of this code was taken from https://github.com/llir/llvm. As
// such, it does not contain features such as sanity checking and IR parsing.
// The main reason this package was created was to add support for opaque
// pointers and drop support for the legacy typed ones.
package llvm