cyrilix/goupnp
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add additional header docs to generated DCP packages.

Browse Source
This commit is contained in:
John Beisley
2014-06-07 21:24:11 +01:00
parent 4370c89058
commit ca8dc4faf5
3 changed files with 32 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
dcps/internetgateway1/internetgateway1.go
View File

@@ -1,3 +1,9 @@
// Client for UPnP Device Control Protocol Internet Gateway Device v1.
//
// This DCP is documented in detail at: http://upnp.org/specs/gw/UPnP-gw-InternetGatewayDevice-v1-Device.pdf
//
// Typically, use one of the New* functions to discover services on the local
// network.
package internetgateway1 package internetgateway1
// Generated file - do not edit by hand. See README.md // Generated file - do not edit by hand. See README.md

6
dcps/internetgateway2/internetgateway2.go
View File

@@ -1,3 +1,9 @@
// Client for UPnP Device Control Protocol Internet Gateway Device v2.
//
// This DCP is documented in detail at: http://upnp.org/specs/gw/UPnP-gw-InternetGatewayDevice-v2-Device.pdf
//
// Typically, use one of the New* functions to discover services on the local
// network.
package internetgateway2 package internetgateway2
// Generated file - do not edit by hand. See README.md // Generated file - do not edit by hand. See README.md

24
gotasks/specgen_task.go
View File

@@ -93,13 +93,24 @@ func TaskSpecgen(t *tasking.T) {
} }
} }
// DCP contains extra metadata to use when generating DCP source files.
type DCPMetadata struct { type DCPMetadata struct {
Name string Name string // What to name the Go DCP package.
OfficialName string // Official name for the DCP.
DocURL string // Optional - URL for futher documentation about the DCP.
} }
var dcpMetadataByDir = map[string]DCPMetadata{ var dcpMetadataByDir = map[string]DCPMetadata{
"Internet Gateway_1": {"internetgateway1"}, "Internet Gateway_1": {
"Internet Gateway_2": {"internetgateway2"}, Name: "internetgateway1",
OfficialName: "Internet Gateway Device v1",
DocURL: "http://upnp.org/specs/gw/UPnP-gw-InternetGatewayDevice-v1-Device.pdf",
},
"Internet Gateway_2": {
Name: "internetgateway2",
OfficialName: "Internet Gateway Device v2",
DocURL: "http://upnp.org/specs/gw/UPnP-gw-InternetGatewayDevice-v2-Device.pdf",
},
} }
type dcpCollection struct { type dcpCollection struct {
@@ -420,7 +431,12 @@ func urnPartsFromSCPDFilename(filename string) (*URNParts, error) {
} }
var packageTmpl = template.Must(template.New("package").Parse(`{{$name := .Metadata.Name}} var packageTmpl = template.Must(template.New("package").Parse(`{{$name := .Metadata.Name}}
// Client for UPnP Device Control Protocol {{.Metadata.OfficialName}}.
// {{if .Metadata.DocURL}}
// This DCP is documented in detail at: {{.Metadata.DocURL}}{{end}}
//
// Typically, use one of the New* functions to discover services on the local
// network.
package {{$name}} package {{$name}}
// Generated file - do not edit by hand. See README.md // Generated file - do not edit by hand. See README.md