40f17faa73
* Added a new template for Functions. Implement the genFunction method for generating the docs for Functions. * Rename type resourceArgs to resourceDocArgs. Minor updates the resource template. * Generate nested types for Functions. * Unexport types that don't need to be exported. Create the doc language helper objects in an init function and reuse them rather than recreating them every time. Update genNestedTypes to work with schema functions or resources. * Fixed bug in nested type generation for Functions. Fixed bug in generating input and output doc links for nested types.
32 lines
1.5 KiB
Go
32 lines
1.5 KiB
Go
// Copyright 2016-2020, Pulumi Corporation.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package codegen
|
|
|
|
import (
|
|
"github.com/pulumi/pulumi/pkg/codegen/schema"
|
|
)
|
|
|
|
// DocLanguageHelper is an interface for extracting language-specific information from a Pulumi schema.
|
|
// See the implementation for this interface under each of the language code generators.
|
|
type DocLanguageHelper interface {
|
|
GetDocLinkForResourceType(packageName, moduleName, typeName string) string
|
|
GetDocLinkForResourceInputOrOutputType(packageName, moduleName, typeName string, input bool) string
|
|
GetDocLinkForFunctionInputOrOutputType(packageName, moduleName, typeName string, input bool) string
|
|
GetLanguageTypeString(pkg *schema.Package, moduleName string, t schema.Type, input, optional bool) string
|
|
// GetResourceFunctionResultName returns the name of the result type when a static resource function is used to lookup
|
|
// an existing resource.
|
|
GetResourceFunctionResultName(resourceName string) string
|
|
}
|