Merge pull request #41 from slimsag/clean_synopsis

Clean up package synopsis.
go-gl · Aug 18, 2014 · 9eef101 · 9eef101
2 parents 0fe43d8 + 166c468
commit 9eef101
Show file tree

Hide file tree

Showing 42 changed files with 221 additions and 56 deletions.
diff --git a/Makefile b/Makefile
@@ -1,18 +1,18 @@
 # Makefile for generating the prebuilt (go-gettable) bindings.
 
 bindings:
-	./glow generate -api=gl -version=2.1
-	./glow generate -api=gl -version=3.2 -profile=core
-	./glow generate -api=gl -version=3.3 -profile=core
-	./glow generate -api=gl -version=4.1 -profile=core
-	./glow generate -api=gl -version=4.4 -profile=core
-	./glow generate -api=gl -version=4.5 -profile=core
-	./glow generate -api=gl -version=all -profile=core -lenientInit
-	./glow generate -api=gl -version=3.2 -profile=compatibility
-	./glow generate -api=gl -version=3.3 -profile=compatibility
-	./glow generate -api=gl -version=4.1 -profile=compatibility
-	./glow generate -api=gl -version=4.4 -profile=compatibility
-	./glow generate -api=gl -version=4.5 -profile=compatibility
+	glow generate -api=gl -version=2.1
+	glow generate -api=gl -version=3.2 -profile=core
+	glow generate -api=gl -version=3.3 -profile=core
+	glow generate -api=gl -version=4.1 -profile=core
+	glow generate -api=gl -version=4.4 -profile=core
+	glow generate -api=gl -version=4.5 -profile=core
+	glow generate -api=gl -version=all -profile=core -lenientInit
+	glow generate -api=gl -version=3.2 -profile=compatibility
+	glow generate -api=gl -version=3.3 -profile=compatibility
+	glow generate -api=gl -version=4.1 -profile=compatibility
+	glow generate -api=gl -version=4.4 -profile=compatibility
+	glow generate -api=gl -version=4.5 -profile=compatibility
 
 format:
 	go fmt ./gl/2.1/gl

diff --git a/conversions.tmpl b/conversions.tmpl
@@ -1,6 +1,8 @@
+//glow:keepspace
 // Glow automatically generated OpenGL binding: http://github.com/go-gl/glow
 
 package {{.Name}}
+//glow:rmspace
 
 import (
 	"C"

diff --git a/debug.tmpl b/debug.tmpl
@@ -1,6 +1,8 @@
+//glow:keepspace
 // Glow automatically generated OpenGL binding: http://github.com/go-gl/glow
 
 package {{.Name}}
+//glow:rmspace
 
 import "C"
 import "unsafe"

diff --git a/gl-compatibility/3.2/gl/conversions.go b/gl-compatibility/3.2/gl/conversions.go
@@ -1,4 +1,5 @@
 // Glow automatically generated OpenGL binding: http://github.com/go-gl/glow
+
 package gl
 
 import (

diff --git a/gl-compatibility/3.2/gl/debug.go b/gl-compatibility/3.2/gl/debug.go
@@ -1,4 +1,5 @@
 // Glow automatically generated OpenGL binding: http://github.com/go-gl/glow
+
 package gl
 
 import "C"

diff --git a/gl-compatibility/3.2/gl/package.go b/gl-compatibility/3.2/gl/package.go
@@ -1,12 +1,19 @@
-// Glow automatically generated OpenGL binding: http://github.com/go-gl/glow
-// Generated based on XML spec SVN revision 27695.
 // Copyright (c) 2010 Khronos Group.
 // This material may be distributed subject to the terms and conditions
 // set forth in the Open Publication License, v 1.0, 8 June 1999.
 // http://opencontent.org/openpub/.
+//
 // Copyright (c) 1991-2006 Silicon Graphics, Inc.
 // This document is licensed under the SGI Free Software B License.
 // For details, see http://oss.sgi.com/projects/FreeB.
+
+// Package gl implements Go bindings to OpenGL.
+//
+// This package was automatically generated using Glow:
+//  http://github.com/go-gl/glow
+//
+// Generated based on the OpenGL XML specification:
+//  SVN revision 27695
 package gl
 
 // #cgo darwin  LDFLAGS: -framework OpenGL
@@ -11241,9 +11248,10 @@ package gl
 import "C"
 import (
 	"errors"
+	"unsafe"
+
 	"github.com/go-gl/glow/procaddr"
 	"github.com/go-gl/glow/procaddr/auto"
-	"unsafe"
 )
 
 const (

diff --git a/gl-compatibility/3.3/gl/conversions.go b/gl-compatibility/3.3/gl/conversions.go
@@ -1,4 +1,5 @@
 // Glow automatically generated OpenGL binding: http://github.com/go-gl/glow
+
 package gl
 
 import (

diff --git a/gl-compatibility/3.3/gl/debug.go b/gl-compatibility/3.3/gl/debug.go
@@ -1,4 +1,5 @@
 // Glow automatically generated OpenGL binding: http://github.com/go-gl/glow
+
 package gl
 
 import "C"

diff --git a/gl-compatibility/3.3/gl/package.go b/gl-compatibility/3.3/gl/package.go
@@ -1,12 +1,19 @@
-// Glow automatically generated OpenGL binding: http://github.com/go-gl/glow
-// Generated based on XML spec SVN revision 27695.
 // Copyright (c) 2010 Khronos Group.
 // This material may be distributed subject to the terms and conditions
 // set forth in the Open Publication License, v 1.0, 8 June 1999.
 // http://opencontent.org/openpub/.
+//
 // Copyright (c) 1991-2006 Silicon Graphics, Inc.
 // This document is licensed under the SGI Free Software B License.
 // For details, see http://oss.sgi.com/projects/FreeB.
+
+// Package gl implements Go bindings to OpenGL.
+//
+// This package was automatically generated using Glow:
+//  http://github.com/go-gl/glow
+//
+// Generated based on the OpenGL XML specification:
+//  SVN revision 27695
 package gl
 
 // #cgo darwin  LDFLAGS: -framework OpenGL
@@ -11245,9 +11252,10 @@ package gl
 import "C"
 import (
 	"errors"
+	"unsafe"
+
 	"github.com/go-gl/glow/procaddr"
 	"github.com/go-gl/glow/procaddr/auto"
-	"unsafe"
 )
 
 const (

diff --git a/gl-compatibility/4.1/gl/conversions.go b/gl-compatibility/4.1/gl/conversions.go
@@ -1,4 +1,5 @@
 // Glow automatically generated OpenGL binding: http://github.com/go-gl/glow
+
 package gl
 
 import (

diff --git a/gl-compatibility/4.1/gl/debug.go b/gl-compatibility/4.1/gl/debug.go
@@ -1,4 +1,5 @@
 // Glow automatically generated OpenGL binding: http://github.com/go-gl/glow
+
 package gl
 
 import "C"

diff --git a/gl-compatibility/4.1/gl/package.go b/gl-compatibility/4.1/gl/package.go
@@ -1,12 +1,19 @@
-// Glow automatically generated OpenGL binding: http://github.com/go-gl/glow
-// Generated based on XML spec SVN revision 27695.
 // Copyright (c) 2010 Khronos Group.
 // This material may be distributed subject to the terms and conditions
 // set forth in the Open Publication License, v 1.0, 8 June 1999.
 // http://opencontent.org/openpub/.
+//
 // Copyright (c) 1991-2006 Silicon Graphics, Inc.
 // This document is licensed under the SGI Free Software B License.
 // For details, see http://oss.sgi.com/projects/FreeB.
+
+// Package gl implements Go bindings to OpenGL.
+//
+// This package was automatically generated using Glow:
+//  http://github.com/go-gl/glow
+//
+// Generated based on the OpenGL XML specification:
+//  SVN revision 27695
 package gl
 
 // #cgo darwin  LDFLAGS: -framework OpenGL
@@ -11265,9 +11272,10 @@ package gl
 import "C"
 import (
 	"errors"
+	"unsafe"
+
 	"github.com/go-gl/glow/procaddr"
 	"github.com/go-gl/glow/procaddr/auto"
-	"unsafe"
 )
 
 const (

diff --git a/gl-compatibility/4.4/gl/conversions.go b/gl-compatibility/4.4/gl/conversions.go
@@ -1,4 +1,5 @@
 // Glow automatically generated OpenGL binding: http://github.com/go-gl/glow
+
 package gl
 
 import (

diff --git a/gl-compatibility/4.4/gl/debug.go b/gl-compatibility/4.4/gl/debug.go
@@ -1,4 +1,5 @@
 // Glow automatically generated OpenGL binding: http://github.com/go-gl/glow
+
 package gl
 
 import "C"

diff --git a/gl-compatibility/4.4/gl/package.go b/gl-compatibility/4.4/gl/package.go
@@ -1,12 +1,19 @@
-// Glow automatically generated OpenGL binding: http://github.com/go-gl/glow
-// Generated based on XML spec SVN revision 27695.
 // Copyright (c) 2010 Khronos Group.
 // This material may be distributed subject to the terms and conditions
 // set forth in the Open Publication License, v 1.0, 8 June 1999.
 // http://opencontent.org/openpub/.
+//
 // Copyright (c) 1991-2006 Silicon Graphics, Inc.
 // This document is licensed under the SGI Free Software B License.
 // For details, see http://oss.sgi.com/projects/FreeB.
+
+// Package gl implements Go bindings to OpenGL.
+//
+// This package was automatically generated using Glow:
+//  http://github.com/go-gl/glow
+//
+// Generated based on the OpenGL XML specification:
+//  SVN revision 27695
 package gl
 
 // #cgo darwin  LDFLAGS: -framework OpenGL
@@ -11265,9 +11272,10 @@ package gl
 import "C"
 import (
 	"errors"
+	"unsafe"
+
 	"github.com/go-gl/glow/procaddr"
 	"github.com/go-gl/glow/procaddr/auto"
-	"unsafe"
 )
 
 const (

diff --git a/gl-compatibility/4.5/gl/conversions.go b/gl-compatibility/4.5/gl/conversions.go
@@ -1,4 +1,5 @@
 // Glow automatically generated OpenGL binding: http://github.com/go-gl/glow
+
 package gl
 
 import (

diff --git a/gl-compatibility/4.5/gl/debug.go b/gl-compatibility/4.5/gl/debug.go
@@ -1,4 +1,5 @@
 // Glow automatically generated OpenGL binding: http://github.com/go-gl/glow
+
 package gl
 
 import "C"

diff --git a/gl-compatibility/4.5/gl/package.go b/gl-compatibility/4.5/gl/package.go
@@ -1,12 +1,19 @@
-// Glow automatically generated OpenGL binding: http://github.com/go-gl/glow
-// Generated based on XML spec SVN revision 27695.
 // Copyright (c) 2010 Khronos Group.
 // This material may be distributed subject to the terms and conditions
 // set forth in the Open Publication License, v 1.0, 8 June 1999.
 // http://opencontent.org/openpub/.
+//
 // Copyright (c) 1991-2006 Silicon Graphics, Inc.
 // This document is licensed under the SGI Free Software B License.
 // For details, see http://oss.sgi.com/projects/FreeB.
+
+// Package gl implements Go bindings to OpenGL.
+//
+// This package was automatically generated using Glow:
+//  http://github.com/go-gl/glow
+//
+// Generated based on the OpenGL XML specification:
+//  SVN revision 27695
 package gl
 
 // #cgo darwin  LDFLAGS: -framework OpenGL
@@ -11325,9 +11332,10 @@ package gl
 import "C"
 import (
 	"errors"
+	"unsafe"
+
 	"github.com/go-gl/glow/procaddr"
 	"github.com/go-gl/glow/procaddr/auto"
-	"unsafe"
 )
 
 const (

diff --git a/gl-core/3.2/gl/conversions.go b/gl-core/3.2/gl/conversions.go
@@ -1,4 +1,5 @@
 // Glow automatically generated OpenGL binding: http://github.com/go-gl/glow
+
 package gl
 
 import (

diff --git a/gl-core/3.2/gl/debug.go b/gl-core/3.2/gl/debug.go
@@ -1,4 +1,5 @@
 // Glow automatically generated OpenGL binding: http://github.com/go-gl/glow
+
 package gl
 
 import "C"

diff --git a/gl-core/3.2/gl/package.go b/gl-core/3.2/gl/package.go
@@ -1,12 +1,19 @@
-// Glow automatically generated OpenGL binding: http://github.com/go-gl/glow
-// Generated based on XML spec SVN revision 27695.
 // Copyright (c) 2010 Khronos Group.
 // This material may be distributed subject to the terms and conditions
 // set forth in the Open Publication License, v 1.0, 8 June 1999.
 // http://opencontent.org/openpub/.
+//
 // Copyright (c) 1991-2006 Silicon Graphics, Inc.
 // This document is licensed under the SGI Free Software B License.
 // For details, see http://oss.sgi.com/projects/FreeB.
+
+// Package gl implements Go bindings to OpenGL.
+//
+// This package was automatically generated using Glow:
+//  http://github.com/go-gl/glow
+//
+// Generated based on the OpenGL XML specification:
+//  SVN revision 27695
 package gl
 
 // #cgo darwin  LDFLAGS: -framework OpenGL
@@ -3812,9 +3819,10 @@ package gl
 import "C"
 import (
 	"errors"
+	"unsafe"
+
 	"github.com/go-gl/glow/procaddr"
 	"github.com/go-gl/glow/procaddr/auto"
-	"unsafe"
 )
 
 const (

diff --git a/gl-core/3.3/gl/conversions.go b/gl-core/3.3/gl/conversions.go
@@ -1,4 +1,5 @@
 // Glow automatically generated OpenGL binding: http://github.com/go-gl/glow
+
 package gl
 
 import (

diff --git a/gl-core/3.3/gl/debug.go b/gl-core/3.3/gl/debug.go
@@ -1,4 +1,5 @@
 // Glow automatically generated OpenGL binding: http://github.com/go-gl/glow
+
 package gl
 
 import "C"

diff --git a/gl-core/3.3/gl/package.go b/gl-core/3.3/gl/package.go
@@ -1,12 +1,19 @@
-// Glow automatically generated OpenGL binding: http://github.com/go-gl/glow
-// Generated based on XML spec SVN revision 27695.
 // Copyright (c) 2010 Khronos Group.
 // This material may be distributed subject to the terms and conditions
 // set forth in the Open Publication License, v 1.0, 8 June 1999.
 // http://opencontent.org/openpub/.
+//
 // Copyright (c) 1991-2006 Silicon Graphics, Inc.
 // This document is licensed under the SGI Free Software B License.
 // For details, see http://oss.sgi.com/projects/FreeB.
+
+// Package gl implements Go bindings to OpenGL.
+//
+// This package was automatically generated using Glow:
+//  http://github.com/go-gl/glow
+//
+// Generated based on the OpenGL XML specification:
+//  SVN revision 27695
 package gl
 
 // #cgo darwin  LDFLAGS: -framework OpenGL
@@ -3816,9 +3823,10 @@ package gl
 import "C"
 import (
 	"errors"
+	"unsafe"
+
 	"github.com/go-gl/glow/procaddr"
 	"github.com/go-gl/glow/procaddr/auto"
-	"unsafe"
 )
 
 const (

diff --git a/gl-core/4.1/gl/conversions.go b/gl-core/4.1/gl/conversions.go
@@ -1,4 +1,5 @@
 // Glow automatically generated OpenGL binding: http://github.com/go-gl/glow
+
 package gl
 
 import (

diff --git a/gl-core/4.1/gl/debug.go b/gl-core/4.1/gl/debug.go
@@ -1,4 +1,5 @@
 // Glow automatically generated OpenGL binding: http://github.com/go-gl/glow
+
 package gl
 
 import "C"