Documentation ¶
Index ¶
- type DocumentGenerator
- type ProtoParser
- type ProtoParserImpl
- func (protoParser *ProtoParserImpl) GetPackageDocumentation(ctx context.Context, packageName string, ...) (*registryv1alpha1.PackageDocumentation, e.ResponseError)
- func (protoParser *ProtoParserImpl) GetPackages(ctx context.Context, fileManifest *manifest2.Manifest, ...) ([]*registryv1alpha1.ModulePackage, e.ResponseError)
- func (protoParser *ProtoParserImpl) TryCompile(ctx context.Context, fileManifest *manifest2.Manifest, ...) e.ResponseError
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DocumentGenerator ¶
type DocumentGenerator interface { GetModulePackages() []string GenerateDocument(packageName string) *registryv1alpha1.PackageDocumentation }
func NewDocumentGenerator ¶
func NewDocumentGenerator(commitName string, linkers linker.Files, parserAccessorHandler bufmoduleprotocompile.ParserAccessorHandler) DocumentGenerator
type ProtoParser ¶
type ProtoParser interface { // TryCompile 尝试编译,查看是否能够编译成功 TryCompile(ctx context.Context, fileManifest *manifest2.Manifest, blobSet *manifest2.BlobSet, dependentManifests []*manifest2.Manifest, dependentBlobSets []*manifest2.BlobSet) e.ResponseError // GetPackageDocumentation 获取package document GetPackageDocumentation(ctx context.Context, packageName string, moduleIdentity bufmoduleref.ModuleIdentity, commitName string, fileManifest *manifest2.Manifest, blobSet *manifest2.BlobSet, dependentIdentities []bufmoduleref.ModuleIdentity, dependentCommits []string, dependentManifests []*manifest2.Manifest, dependentBlobSets []*manifest2.BlobSet) (*registryv1alpha1.PackageDocumentation, e.ResponseError) // GetPackages 获取所有的package GetPackages(ctx context.Context, fileManifest *manifest2.Manifest, blobSet *manifest2.BlobSet, dependentManifests []*manifest2.Manifest, dependentBlobSets []*manifest2.BlobSet) ([]*registryv1alpha1.ModulePackage, e.ResponseError) }
func NewProtoParser ¶
func NewProtoParser() ProtoParser
type ProtoParserImpl ¶
type ProtoParserImpl struct{}
func (*ProtoParserImpl) GetPackageDocumentation ¶
func (protoParser *ProtoParserImpl) GetPackageDocumentation(ctx context.Context, packageName string, moduleIdentity bufmoduleref.ModuleIdentity, commitName string, fileManifest *manifest2.Manifest, blobSet *manifest2.BlobSet, dependentIdentities []bufmoduleref.ModuleIdentity, dependentCommits []string, dependentManifests []*manifest2.Manifest, dependentBlobSets []*manifest2.BlobSet) (*registryv1alpha1.PackageDocumentation, e.ResponseError)
func (*ProtoParserImpl) GetPackages ¶
func (protoParser *ProtoParserImpl) GetPackages(ctx context.Context, fileManifest *manifest2.Manifest, blobSet *manifest2.BlobSet, dependentManifests []*manifest2.Manifest, dependentBlobSets []*manifest2.BlobSet) ([]*registryv1alpha1.ModulePackage, e.ResponseError)
func (*ProtoParserImpl) TryCompile ¶
Click to show internal directories.
Click to hide internal directories.