Skip to content

Commit 38b2b37

Browse files
committed
Change docs to godoc style instead of markdown
1 parent cc06d69 commit 38b2b37

File tree

1 file changed

+59
-40
lines changed

1 file changed

+59
-40
lines changed

doc.go

Lines changed: 59 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -3,50 +3,69 @@
33
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
44

55
/*
6-
WSDL to Go
7-
8-
Generates Go code from a WSDL file. This project is originally intended to generate Go clients for WS-* services.
9-
10-
### Features
11-
* Supports only Document/Literal wrapped services, which are [WS-I](http://ws-i.org/) compliant
12-
* Attempts to generate idiomatic Go code as much as possible
13-
* Generates Go code in parallel: types, operations and soap proxy
14-
* Supports:
15-
* WSDL 1.1
16-
* XML Schema 1.0
17-
* SOAP 1.1
18-
* Resolves external XML Schemas recursively, up to 5 recursions.
19-
* Supports providing WSDL HTTP URL as well as a local WSDL file
20-
21-
### Not supported
22-
* Setting SOAP headers
23-
* SOAP 1.2 and HTTP port bindings
24-
* WS-Security
25-
* WS-Addressing
26-
* MTOM binary attachments
27-
* UDDI
28-
29-
### Usage
30-
```
31-
gowsdl [OPTIONS]
6+
7+
Gowsdl generates Go code from a WSDL file.
8+
9+
This project is originally intended to generate Go clients for WS-* services.
10+
11+
Usage:
12+
gowsdl [OPTIONS]
3213
3314
Application Options:
34-
-v, --version Shows gowsdl version
35-
-p, --package= Package under which code will be generated (myservice)
36-
-o, --output= File where the generated code will be saved (myservice.go)
37-
-i, --ignore-tls Ignores invalid TLS certificates. It is not recomended for production. Use at your own risk
38-
(false)
15+
-v, --version
16+
Shows gowsdl version
17+
-p, --package=myservice
18+
Package under which code will be generated
19+
-o, --output=myservice.go
20+
File where the generated code will be saved
21+
-i, --ignore-tls
22+
Ignores invalid TLS certificates. It is not recomended for production.
23+
Use at your own risk.
24+
3925
4026
Help Options:
41-
-h, --help Show this help message
42-
```
43-
44-
### TODO
45-
* Add support for filters to allow the user to change the generated code
46-
* If WSDL file is local, resolve external XML schemas locally too instead of failing due to not having a URL to download them from.
47-
* Resolve XSD element references
48-
* Support for generating namespaces
49-
* Make code generation agnostic so generating code to other programming languages is feasible through plugins
27+
-h, --help
28+
Show this help message
29+
30+
Features
31+
32+
Supports only Document/Literal wrapped services, which are WS-I (http://ws-i.org/) compliant.
33+
34+
Attempts to generate idiomatic Go code as much as possible.
35+
36+
Generates Go code in parallel: types, operations and soap proxy.
37+
38+
Supports WSDL 1.1, XML Schema 1.0, SOAP 1.1.
39+
40+
Resolves external XML Schemas recursively, up to 5 recursions.
41+
42+
Supports providing WSDL HTTP URL as well as a local WSDL file.
43+
44+
Not supported
45+
46+
Setting SOAP headers.
47+
48+
SOAP 1.2 and HTTP port bindings.
49+
50+
WS-Security.
51+
52+
WS-Addressing.
53+
54+
MTOM binary attachments.
55+
56+
UDDI.
57+
58+
TODO
59+
60+
Add support for filters to allow the user to change the generated code.
61+
62+
If WSDL file is local, resolve external XML schemas locally too instead of failing due to not having a URL to download them from.
63+
64+
Resolve XSD element references.
65+
66+
Support for generating namespaces.
67+
68+
Make code generation agnostic so generating code to other programming languages is feasible through plugins.
5069
5170
*/
5271
package main

0 commit comments

Comments
 (0)