parsecomment

package
Version: v1.3.0 Latest Latest
Warning

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

Go to latest
Published: Jan 26, 2019 License: MIT Imports: 5 Imported by: 1

Documentation

Overview

Package parsecomment parses the contract from the function comment.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Contract

type Contract struct {
	Pres     []parsecond.Condition
	Posts    []parsecond.Condition
	Preamble string
}

Contract bundles the conditions and the preamble of the function's contract.

func ToContract

func ToContract(name string, commentLines []string) (c Contract, err error)

ToContract parses the contract from the function's documentation.

Source Files

Directories

Path Synopsis
Package parsecond parses the condition from the function documentation.
Package parsecond parses the condition from the function documentation.

Jump to

Keyboard shortcuts

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