You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@plc4x.apache.org by sr...@apache.org on 2022/08/11 13:36:46 UTC
[plc4x] branch develop updated: chores(plc4go): added some top level docs for plc4go
This is an automated email from the ASF dual-hosted git repository.
sruehl pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/plc4x.git
The following commit(s) were added to refs/heads/develop by this push:
new 6d24656f8 chores(plc4go): added some top level docs for plc4go
6d24656f8 is described below
commit 6d24656f80cbe6d3b7d223c256eacc13583f556c
Author: Sebastian Rühl <sr...@apache.org>
AuthorDate: Thu Aug 11 15:36:41 2022 +0200
chores(plc4go): added some top level docs for plc4go
---
plc4go/examples/doc.go | 21 +++++++++++++++++++++
plc4go/internal/doc.go | 21 +++++++++++++++++++++
plc4go/pkg/api/doc.go | 21 +++++++++++++++++++++
plc4go/tests/doc.go | 21 +++++++++++++++++++++
plc4go/tools/doc.go | 21 +++++++++++++++++++++
5 files changed, 105 insertions(+)
diff --git a/plc4go/examples/doc.go b/plc4go/examples/doc.go
new file mode 100644
index 000000000..e37a6323c
--- /dev/null
+++ b/plc4go/examples/doc.go
@@ -0,0 +1,21 @@
+/*
+ * Licensed to the 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. The 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
+ *
+ * https://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 examples contains some examples how to use plc4go (go part of plc4x)
+package examples
diff --git a/plc4go/internal/doc.go b/plc4go/internal/doc.go
new file mode 100644
index 000000000..52bd47b14
--- /dev/null
+++ b/plc4go/internal/doc.go
@@ -0,0 +1,21 @@
+/*
+ * Licensed to the 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. The 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
+ *
+ * https://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 internal contains the plc4go implementation
+package internal
diff --git a/plc4go/pkg/api/doc.go b/plc4go/pkg/api/doc.go
new file mode 100644
index 000000000..ac7caf0e6
--- /dev/null
+++ b/plc4go/pkg/api/doc.go
@@ -0,0 +1,21 @@
+/*
+ * Licensed to the 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. The 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
+ *
+ * https://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 plc4go contains the main API for plc4go (go part of plc4x)
+package plc4go
diff --git a/plc4go/tests/doc.go b/plc4go/tests/doc.go
new file mode 100644
index 000000000..dee2cd757
--- /dev/null
+++ b/plc4go/tests/doc.go
@@ -0,0 +1,21 @@
+/*
+ * Licensed to the 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. The 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
+ *
+ * https://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 tests contains random tests for plc4go
+package tests
diff --git a/plc4go/tools/doc.go b/plc4go/tools/doc.go
new file mode 100644
index 000000000..a47b844de
--- /dev/null
+++ b/plc4go/tools/doc.go
@@ -0,0 +1,21 @@
+/*
+ * Licensed to the 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. The 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
+ *
+ * https://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 tools various tools for working with plc4x
+package tools