From 88cfa972dc3313d5982da4b58a330892d469b7d6 Mon Sep 17 00:00:00 2001 From: Hraban Luyat <hraban@0brg.net> Date: Thu, 29 Dec 2016 14:53:04 +0000 Subject: [PATCH] Deprecation comments more noticeable in godoc.org --- errors.go | 71 ++++++++++++++++++++++++++++++++++++------------------- opus.go | 6 ++--- 2 files changed, 50 insertions(+), 27 deletions(-) diff --git a/errors.go b/errors.go index 5448434..ab87730 100644 --- 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 1ec60b3..9040d77 100644 --- 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) ) -- 2.51.0