Refactored binapi generator with message encoding

[govpp.git] / cmd / binapi-generator / doc.go

diff --git a/cmd/binapi-generator/doc.go b/cmd/binapi-generator/doc.go
index e8556ec..9be49e2 100644 (file)
--- a/cmd/binapi-generator/doc.go
+++ b/cmd/binapi-generator/doc.go
@@ -1,4 +1,18 @@
-// Generator of Go structs out of the VPP binary API definitions in JSON format.
+//  Copyright (c) 2020 Cisco and/or its affiliates.
+//
+//  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.
+
+// Context of Go structs out of the VPP binary API definitions in JSON format.
 //
 // The JSON input can be specified as a single file (using the `input-file`
 // CLI flag), or as a directory that will be scanned for all `.json` files
@@ -7,7 +21,6 @@
 // where each Go package will be placed into its own separate directory,
 // for example:
 //
-//    binapi-generator --input-file=examples/bin_api/acl.api.json --output-dir=examples/bin_api
-//    binapi-generator --input-dir=examples/bin_api --output-dir=examples/bin_api
+//    binapi-generator --input-file=/usr/share/vpp/api/core/interface.api.json --output-dir=.
 //
 package main