Fix doc error (#3375)

This commit is contained in:
jimying 2023-02-16 10:03:01 +08:00 committed by GitHub
parent cba612aa98
commit 8054a92cd5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 31 additions and 22 deletions

View File

@ -57,7 +57,7 @@ doc:
clean-doc:
for dir in pjlib pjlib-util pjnath pjmedia pjsip; do \
rm -rf ./$${dir}/docs/html ./$${dir}/docs/xml ./$${dir}/docs/latex ./$${dir}/docs/$${dir}.tag; \
rm -rf $${dir}/docs/$${PJ_VERSION}; \
done
LIBS = pjlib/lib/libpj-$(TARGET_NAME).a \

View File

@ -994,14 +994,20 @@
* Secure socket implementation.
* Select one of these implementations in PJ_SSL_SOCK_IMP.
*/
#define PJ_SSL_SOCK_IMP_NONE 0 /**< Disable SSL socket. */
#define PJ_SSL_SOCK_IMP_OPENSSL 1 /**< Using OpenSSL. */
#define PJ_SSL_SOCK_IMP_GNUTLS 2 /**< Using GnuTLS. */
#define PJ_SSL_SOCK_IMP_DARWIN 3 /**< Using Apple's Secure
Transport (deprecated in
MacOS 10.15 & iOS 13.0)*/
#define PJ_SSL_SOCK_IMP_APPLE 4 /**< Using Apple's Network
framework. */
/** Disable SSL socket */
#define PJ_SSL_SOCK_IMP_NONE 0
/** Using OpenSSL */
#define PJ_SSL_SOCK_IMP_OPENSSL 1
/**< Using GnuTLS */
#define PJ_SSL_SOCK_IMP_GNUTLS 2
/** Using Apple's Secure Transport (deprecated in MacOS 10.15 & iOS 13.0) */
#define PJ_SSL_SOCK_IMP_DARWIN 3
/** Using Apple's Network framework */
#define PJ_SSL_SOCK_IMP_APPLE 4
/**
* Select which SSL socket implementation to use. Currently pjlib supports

View File

@ -67,7 +67,8 @@ PJ_BEGIN_DECL
*
* @subsection codec_inst Codec Instance
*
* Application allocates codec instance by calling #pjmedia_codec_mgr_alloc_codec().
* Application allocates codec instance by calling
* #pjmedia_codec_mgr_alloc_codec().
* One codec instance (#pjmedia_codec) can be used for simultaneous encoding
* and decoding.
*

View File

@ -369,15 +369,17 @@
* Sample rate conversion backends.
* Select one of these backends in PJMEDIA_RESAMPLE_IMP.
*/
#define PJMEDIA_RESAMPLE_NONE 1 /**< No resampling. */
#define PJMEDIA_RESAMPLE_LIBRESAMPLE 2 /**< Sample rate conversion
using libresample. */
#define PJMEDIA_RESAMPLE_SPEEX 3 /**< Sample rate conversion
using Speex. */
#define PJMEDIA_RESAMPLE_LIBSAMPLERATE 4 /**< Sample rate conversion
using libsamplerate
(a.k.a Secret Rabbit Code)
*/
/** No resampling */
#define PJMEDIA_RESAMPLE_NONE 1
/** Sample rate conversion using libresample */
#define PJMEDIA_RESAMPLE_LIBRESAMPLE 2
/** Sample rate conversion using Speex */
#define PJMEDIA_RESAMPLE_SPEEX 3
/** Sample rate conversion using libsamplerate (a.k.a Secret Rabbit Code) */
#define PJMEDIA_RESAMPLE_LIBSAMPLERATE 4
/**
* Select which resample implementation to use. Currently pjmedia supports:

View File

@ -57,8 +57,8 @@ PJ_BEGIN_DECL
* session.
*
* When application wants to send RTP packet, it needs to call
* #pjmedia_rtp_encode_rtp() to build the RTP header. Note that this WILL NOT build
* the complete RTP packet, but instead only the header. Application can
* #pjmedia_rtp_encode_rtp() to build the RTP header. Note that this WILL NOT
* build the complete RTP packet, but instead only the header. Application can
* then either concatenate the header with the payload, or send the two
* fragments (the header and the payload) using scatter-gather transport API
* (e.g. \a sendv()).

View File

@ -53,7 +53,7 @@ the security policy of an organization, while NAT is a connectivity solution
to allow multiple hosts to use a single public IP address. Understandably
both functionalities are difficult to separate at times, since many
(typically consumer) products claims to do both with the same device and
simply label the device a NAT box. But we do want to make this distinction
simply label the device a "NAT box". But we do want to make this distinction
rather clear, as PJNATH is a NAT traversal helper and not a firewall bypass
solution (yet).