From 17f211c393772f30922bac595592e3fe60c2ef25 Mon Sep 17 00:00:00 2001 From: Jesse Hallam Date: Fri, 13 Jul 2018 10:29:50 -0400 Subject: MM-11292: clean up plugins GoDoc (#9109) * clean up plugins GoDoc: - eliminate plugin.NewBlankContext() as unnecessary - export ValidIdRegex as a string vs. the less readable var - add/update various documentation strings - hide everything by default, except where used by client plugins or the mattermost-server. The exception to this rule are the `*(Args|Returns)` structs which must be public for go-plugin, but are now prefixed with `Z_` with a warning not to use. - include a top-level example to get plugin authors started This is not a breaking change for existing plugins compiled against plugins-v2. * remove commented out ServeHTTPResponseWriter * update examples to match developer docs * add missing plugin/doc.go license header --- plugin/doc.go | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 plugin/doc.go (limited to 'plugin/doc.go') diff --git a/plugin/doc.go b/plugin/doc.go new file mode 100644 index 000000000..b6806365b --- /dev/null +++ b/plugin/doc.go @@ -0,0 +1,9 @@ +// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved. +// See LICENSE.txt for license information. + +// The plugin package is used by Mattermost server plugins written in go. It also enables the +// Mattermost server to manage and interact with the running plugin environment. +// +// Note that this package exports a large number of types prefixed with Z_. These are public only +// to allow their use with Hashicorp's go-plugin (and net/rpc). Do not use these directly. +package plugin -- cgit v1.2.3-1-g7c22