From d62960833658f1d0c3599ec64bd88474d237b074 Mon Sep 17 00:00:00 2001 From: Camilo Aguilar Date: Wed, 3 Sep 2014 00:52:58 -0400 Subject: [PATCH] Formats godoc --- doc.go | 94 ++++++++++++++++++++++++++++++---------------------------- 1 file changed, 48 insertions(+), 46 deletions(-) diff --git a/doc.go b/doc.go index 1af039b..e8d7ef6 100644 --- a/doc.go +++ b/doc.go @@ -1,58 +1,60 @@ -/*# WSDL to Go +/* +WSDL to Go + Generates Go code from a WSDL file. This project is originally intended to generate Go clients for WS-* services. -### Features -* Supports only Document/Literal wrapped services, which are [WS-I](http://ws-i.org/) compliant -* Attempts to generate idiomatic Go code as much as possible -* Generates Go code in parallel: types, operations and soap proxy -* Supports: - * WSDL 1.1 - * XML Schema 1.0 - * SOAP 1.1 -* Resolves external XML Schemas recursively, up to 5 recursions. -* Supports providing WSDL HTTP URL as well as a local WSDL file - -### Not supported -* Setting SOAP headers -* SOAP 1.2 and HTTP port bindings -* WS-Security - -### Usage -``` -gowsdl [OPTIONS] - -Application Options: - -v, --version Shows gowsdl version - -p, --package= Package under which code will be generated (myservice) - -o, --output= File where the generated code will be saved (myservice.go) - -i, --ignore-tls Ignores invalid TLS certificates. It is not recomended for production. Use at your own risk +Features + * Supports only Document/Literal wrapped services, which are [WS-I](http://ws-i.org/) compliant + * Attempts to generate idiomatic Go code as much as possible + * Generates Go code in parallel: types, operations and soap proxy + * Supports: + * WSDL 1.1 + * XML Schema 1.0 + * SOAP 1.1 + * Resolves external XML Schemas recursively, up to 5 recursions. + * Supports providing WSDL HTTP URL as well as a local WSDL file + +Not supported + * Setting SOAP headers + * SOAP 1.2 and HTTP port bindings + * WS-Security + +Usage + + gowsdl [OPTIONS] + + Application Options: + -v, --version Shows gowsdl version + -p, --package= Package under which code will be generated (myservice) + -o, --output= File where the generated code will be saved (myservice.go) + -i, --ignore-tls Ignores invalid TLS certificates. It is not recomended for production. Use at your own risk (false) -Help Options: - -h, --help Show this help message -``` + Help Options: + -h, --help Show this help message + -### TODO -* Add support for filters to allow the user to change the generated code -* If WSDL file is local, resolve external XML schemas locally too instead of failing due to not having a URL to download them from. -* Resolve XSD element references -* Support for generating namespaces -* Make code generation agnostic so generating code to other programming languages is feasible through plugins +TODO + * Add support for filters to allow the user to change the generated code + * If WSDL file is local, resolve external XML schemas locally too instead of failing due to not having a URL to download them from. + * Resolve XSD element references + * Support for generating namespaces + * Make code generation agnostic so generating code to other programming languages is feasible through plugins -## License -Copyright 2014 Cloudescape +License + Copyright 2014 Cloudescape -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 + 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 + 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. + 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 main