Deprecation comments more noticeable in godoc.org

diff --git a/errors.go b/errors.go
index 5448434f316aaebba7f3aa4469f81ee628f7f908..ab8773073c2e6e48f9fbbade2423607c587a0086 100644 (file)
--- a/errors.go
+++ b/errors.go
@@ -60,17 +60,25 @@ var (
        ErrAllocFail      = Error(C.CONST_OPUS_ALLOC_FAIL)
 )
 
-// DEPRECATED versions of the above variables. Will be removed end of 2017.
-// Please don't use.
+// DEPRECATED versions of the camel cased names. Will be removed end of
+// 2017.  Please don't use.
 var (
-       ERR_OPUS_OK               = Error(C.CONST_OPUS_OK)
-       ERR_OPUS_BAD_ARG          = Error(C.CONST_OPUS_BAD_ARG)
+       // DEPRECATED - DON'T USE - Use the camel cased version
+       ERR_OPUS_OK = Error(C.CONST_OPUS_OK)
+       // DEPRECATED - DON'T USE - Use the camel cased version
+       ERR_OPUS_BAD_ARG = Error(C.CONST_OPUS_BAD_ARG)
+       // DEPRECATED - DON'T USE - Use the camel cased version
        ERR_OPUS_BUFFER_TOO_SMALL = Error(C.CONST_OPUS_BUFFER_TOO_SMALL)
-       ERR_OPUS_INTERNAL_ERROR   = Error(C.CONST_OPUS_INTERNAL_ERROR)
-       ERR_OPUS_INVALID_PACKET   = Error(C.CONST_OPUS_INVALID_PACKET)
-       ERR_OPUS_UNIMPLEMENTED    = Error(C.CONST_OPUS_UNIMPLEMENTED)
-       ERR_OPUS_INVALID_STATE    = Error(C.CONST_OPUS_INVALID_STATE)
-       ERR_OPUS_ALLOC_FAIL       = Error(C.CONST_OPUS_ALLOC_FAIL)
+       // DEPRECATED - DON'T USE - Use the camel cased version
+       ERR_OPUS_INTERNAL_ERROR = Error(C.CONST_OPUS_INTERNAL_ERROR)
+       // DEPRECATED - DON'T USE - Use the camel cased version
+       ERR_OPUS_INVALID_PACKET = Error(C.CONST_OPUS_INVALID_PACKET)
+       // DEPRECATED - DON'T USE - Use the camel cased version
+       ERR_OPUS_UNIMPLEMENTED = Error(C.CONST_OPUS_UNIMPLEMENTED)
+       // DEPRECATED - DON'T USE - Use the camel cased version
+       ERR_OPUS_INVALID_STATE = Error(C.CONST_OPUS_INVALID_STATE)
+       // DEPRECATED - DON'T USE - Use the camel cased version
+       ERR_OPUS_ALLOC_FAIL = Error(C.CONST_OPUS_ALLOC_FAIL)
 )
 
 // Error string (in human readable format) for libopus errors.
@@ -102,23 +110,38 @@ var (
        ErrStreamBadTimestamp = StreamError(C.CONST_OP_EBADTIMESTAMP)
 )
 
-// DEPRECATED versions of the above variables. Will be removed end of 2017.
+// DEPRECATED versions of the camel cased names. Will be removed end of 2017.
 // Please don't use.
 var (
-       ERR_OP_FALSE         = StreamError(C.CONST_OP_FALSE)
-       ERR_OP_EOF           = StreamError(C.CONST_OP_EOF)
-       ERR_OP_HOLE          = StreamError(C.CONST_OP_HOLE)
-       ERR_OP_EREAD         = StreamError(C.CONST_OP_EREAD)
-       ERR_OP_EFAULT        = StreamError(C.CONST_OP_EFAULT)
-       ERR_OP_EIMPL         = StreamError(C.CONST_OP_EIMPL)
-       ERR_OP_EINVAL        = StreamError(C.CONST_OP_EINVAL)
-       ERR_OP_ENOTFORMAT    = StreamError(C.CONST_OP_ENOTFORMAT)
-       ERR_OP_EBADHEADER    = StreamError(C.CONST_OP_EBADHEADER)
-       ERR_OP_EVERSION      = StreamError(C.CONST_OP_EVERSION)
-       ERR_OP_ENOTAUDIO     = StreamError(C.CONST_OP_ENOTAUDIO)
-       ERR_OP_EBADPACKET    = StreamError(C.CONST_OP_EBADPACKET)
-       ERR_OP_EBADLINK      = StreamError(C.CONST_OP_EBADLINK)
-       ERR_OP_ENOSEEK       = StreamError(C.CONST_OP_ENOSEEK)
+       // DEPRECATED - DON'T USE - Use the camel cased version
+       ERR_OP_FALSE = StreamError(C.CONST_OP_FALSE)
+       // DEPRECATED - DON'T USE - Use the camel cased version
+       ERR_OP_EOF = StreamError(C.CONST_OP_EOF)
+       // DEPRECATED - DON'T USE - Use the camel cased version
+       ERR_OP_HOLE = StreamError(C.CONST_OP_HOLE)
+       // DEPRECATED - DON'T USE - Use the camel cased version
+       ERR_OP_EREAD = StreamError(C.CONST_OP_EREAD)
+       // DEPRECATED - DON'T USE - Use the camel cased version
+       ERR_OP_EFAULT = StreamError(C.CONST_OP_EFAULT)
+       // DEPRECATED - DON'T USE - Use the camel cased version
+       ERR_OP_EIMPL = StreamError(C.CONST_OP_EIMPL)
+       // DEPRECATED - DON'T USE - Use the camel cased version
+       ERR_OP_EINVAL = StreamError(C.CONST_OP_EINVAL)
+       // DEPRECATED - DON'T USE - Use the camel cased version
+       ERR_OP_ENOTFORMAT = StreamError(C.CONST_OP_ENOTFORMAT)
+       // DEPRECATED - DON'T USE - Use the camel cased version
+       ERR_OP_EBADHEADER = StreamError(C.CONST_OP_EBADHEADER)
+       // DEPRECATED - DON'T USE - Use the camel cased version
+       ERR_OP_EVERSION = StreamError(C.CONST_OP_EVERSION)
+       // DEPRECATED - DON'T USE - Use the camel cased version
+       ERR_OP_ENOTAUDIO = StreamError(C.CONST_OP_ENOTAUDIO)
+       // DEPRECATED - DON'T USE - Use the camel cased version
+       ERR_OP_EBADPACKET = StreamError(C.CONST_OP_EBADPACKET)
+       // DEPRECATED - DON'T USE - Use the camel cased version
+       ERR_OP_EBADLINK = StreamError(C.CONST_OP_EBADLINK)
+       // DEPRECATED - DON'T USE - Use the camel cased version
+       ERR_OP_ENOSEEK = StreamError(C.CONST_OP_ENOSEEK)
+       // DEPRECATED - DON'T USE - Use the camel cased version
        ERR_OP_EBADTIMESTAMP = StreamError(C.CONST_OP_EBADTIMESTAMP)
 )
 

diff --git a/opus.go b/opus.go
index 1ec60b35b9dd0d98425944b9ef01943afc35289e..9040d7725a423e1517ebf66fc90fa8a01258748e 100644 (file)
--- a/opus.go
+++ b/opus.go
@@ -31,11 +31,11 @@ var (
 
 // DEPRECATED -- Don't use these. Will be removed end of 2017.
 var (
-       // Optimize encoding for VOIP
+       // DEPRECATED - DON'T USE - Use the camel cased version
        APPLICATION_VOIP = Application(C.CONST_APPLICATION_VOIP)
-       // Optimize encoding for non-voice signals like music
+       // DEPRECATED - DON'T USE - Use the camel cased version
        APPLICATION_AUDIO = Application(C.CONST_APPLICATION_AUDIO)
-       // Optimize encoding for low latency applications
+       // DEPRECATED - DON'T USE - Use the camel cased version
        APPLICATION_RESTRICTED_LOWDELAY = Application(C.CONST_APPLICATION_RESTRICTED_LOWDELAY)
 )