comments

package
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 14, 2021 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Licensed to Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. Apache Software Foundation (ASF) licenses this file to you 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.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CommentStyle

type CommentStyle struct {
	ID           string `yaml:"id"`
	After        string `yaml:"after"`
	Start        string `yaml:"start"`
	Middle       string `yaml:"middle"`
	End          string `yaml:"end"`
	EnsureAfter  string `yaml:"ensure_after"`
	EnsureBefore string `yaml:"ensure_before"`
}

func FileCommentStyle

func FileCommentStyle(filename string) *CommentStyle

func (*CommentStyle) Validate

func (style *CommentStyle) Validate() error

type Language

type Language struct {
	Type           string   `yaml:"type"`
	Extensions     []string `yaml:"extensions"`
	Filenames      []string `yaml:"filenames"`
	CommentStyleID string   `yaml:"comment_style_id"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL