Merge pull request #31 from ms2008/master

agentzh · agentzh · commit 5386b606c8c2 · 2016-03-10T12:05:39.000-08:00
doc: resty document style fix.
diff --git a/lib/ngx/balancer.md b/lib/ngx/balancer.md
@@ -97,7 +97,7 @@ to call these methods.
 
 set_current_peer
 ----------------
-**syntax:** `ok, err = balancer.set_current_peer(host, port)`
+**syntax:** *ok, err = balancer.set_current_peer(host, port)*
 
 **context:** *balancer_by_lua&#42;*
 
@@ -113,7 +113,7 @@ and pass the results to the `balancer_by_lua*` handler via [ngx.ctx](https://git
 
 set_more_tries
 --------------
-**syntax:** `ok, err = balancer.set_more_tries(count)`
+**syntax:** *ok, err = balancer.set_more_tries(count)*
 
 **context:** *balancer_by_lua&#42;*
 
@@ -132,7 +132,7 @@ is still a `true` value.
 
 get_last_failure
 ----------------
-**syntax:** `state_name, status_code = balancer.get_last_failure()`
+**syntax:** *state_name, status_code = balancer.get_last_failure()*
 
 **context:** *balancer_by_lua&#42;*
 
diff --git a/lib/ngx/ocsp.md b/lib/ngx/ocsp.md
@@ -153,7 +153,7 @@ Methods
 
 get_ocsp_responder_from_der_chain
 ---------------------------------
-**syntax:** `ocsp_url, err = ocsp.get_ocsp_responder_from_der_chain(der_cert_chain, max_len)`
+**syntax:** *ocsp_url, err = ocsp.get_ocsp_responder_from_der_chain(der_cert_chain, max_len)*
 
 **context:** *any*
 
@@ -172,7 +172,7 @@ In case of failures, returns `nil` and a string describing the error.
 
 create_ocsp_request
 -------------------
-**syntax:** `ocsp_req, err = ocsp.create_ocsp_request(der_cert_chain, max_len)`
+**syntax:** *ocsp_req, err = ocsp.create_ocsp_request(der_cert_chain, max_len)*
 
 **context:** *any*
 
@@ -195,7 +195,7 @@ by the [get_ocsp_responder_from_der_chain](#get_ocsp_responder_from_der_chain) f
 
 validate_ocsp_response
 ----------------------
-**syntax:** `ok, err = ocsp.validate_ocsp_response(ocsp_resp, der_cert_chain, max_err_msg_len)`
+**syntax:** *ok, err = ocsp.validate_ocsp_response(ocsp_resp, der_cert_chain, max_err_msg_len)*
 
 **context:** *any*
 
@@ -214,7 +214,7 @@ being 4KB).
 
 set_ocsp_status_resp
 --------------------
-**syntax:** `ok, err = ocsp.set_ocsp_status_resp(ocsp_resp)`
+**syntax:** *ok, err = ocsp.set_ocsp_status_resp(ocsp_resp)*
 
 **context:** *ssl_certificate_by_lua&#42;*
 
diff --git a/lib/ngx/semaphore.md b/lib/ngx/semaphore.md
@@ -172,7 +172,7 @@ new
 ---
 **syntax:** *sema, err = semaphore_module.new(n?)*
 
-**context:** **init_by_lua*, init_worker_by_lua*, set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua, log_by_lua*, ngx.timer.**
+**context:** *init_by_lua&#42;, init_worker_by_lua&#42;, set_by_lua&#42;, rewrite_by_lua&#42;, access_by_lua&#42;, content_by_lua&#42;, header_filter_by_lua&#42;, body_filter_by_lua&#42;, log_by_lua&#42;, ngx.timer.&#42;*
 
 Creates and returns a new semaphore instance that has `n` (default to `0`) resources.
 
@@ -197,7 +197,7 @@ post
 --------
 **syntax:** *sema:post(n?)*
 
-**context:** *init_by_lua*, init_worker_by_lua*, set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua, log_by_lua*, ngx.timer.**
+**context:** *init_by_lua&#42;, init_worker_by_lua&#42;, set_by_lua&#42;, rewrite_by_lua&#42;, access_by_lua&#42;, content_by_lua&#42;, header_filter_by_lua&#42;, body_filter_by_lua&#42;, log_by_lua&#42;, ngx.timer.&#42;*
 
 Releases `n` (default to `1`) "resources" to the semaphore instance.
 
@@ -221,7 +221,7 @@ wait
 ------------
 **syntax:** *ok, err = sema:wait(timeout)*
 
-**context:** *rewrite_by_lua*, access_by_lua*, content_by_lua*, ngx.timer.**
+**context:** *rewrite_by_lua&#42;, access_by_lua&#42;, content_by_lua&#42;, ngx.timer.&#42;*
 
 Requests a resource from the semaphore instance.
 
@@ -244,10 +244,10 @@ See [Synopsis](#synopsis) for code examples.
 
 count
 --------
-**syntax:** `count = sema:count()`
+**syntax:** *count = sema:count()*
 
-**context:** *init_by_lua*, init_worker_by_lua*, set_by_lua*, rewrite_by_lua*, access_by_lua*,
-content_by_lua*, header_filter_by_lua*, body_filter_by_lua, log_by_lua*, ngx.timer.**
+**context:** *init_by_lua&#42;, init_worker_by_lua&#42;, set_by_lua&#42;, rewrite_by_lua&#42;, access_by_lua&#42;,
+content_by_lua&#42;, header_filter_by_lua&#42;, body_filter_by_lua&#42;, log_by_lua&#42;, ngx.timer.&#42;*
 
 Returns the number of resources readily available in the `sema` semaphore instance (if any).
 
diff --git a/lib/ngx/ssl.md b/lib/ngx/ssl.md
@@ -121,7 +121,7 @@ Methods
 
 clear_certs
 -----------
-**syntax:** `ok, err = ssl.clear_certs()`
+**syntax:** *ok, err = ssl.clear_certs()*
 
 **context:** *ssl_certificate_by_lua&#42;*
 
@@ -133,7 +133,7 @@ Returns `true` on success, or a `nil` value and a string describing the error ot
 
 cert_pem_to_der
 ---------------
-**syntax:** `der_cert_chain, err = ssl.cert_pem_to_der(pem_cert_chain)`
+**syntax:** *der_cert_chain, err = ssl.cert_pem_to_der(pem_cert_chain)*
 
 **context:** *any*
 
@@ -155,7 +155,7 @@ This function can be called in whatever contexts.
 
 set_der_cert
 ------------
-**syntax:** `ok, err = ssl.set_der_cert(der_cert_chain)`
+**syntax:** *ok, err = ssl.set_der_cert(der_cert_chain)*
 
 **context:** *ssl_certificate_by_lua&#42;*
 
@@ -173,7 +173,7 @@ function to do the conversion first.
 
 priv_key_pem_to_der
 -------------------
-**syntax:** `der_priv_key, err = ssl.priv_key_pem_to_der(pem_priv_key)`
+**syntax:** *der_priv_key, err = ssl.priv_key_pem_to_der(pem_priv_key)*
 
 **context:** *any*
 
@@ -195,7 +195,7 @@ This function can be called in whatever contexts.
 
 set_der_priv_key
 ----------------
-**syntax:** `ok, err = ssl.set_der_priv_key(der_cert_chain)`
+**syntax:** *ok, err = ssl.set_der_priv_key(der_cert_chain)*
 
 **context:** *ssl_certificate_by_lua&#42;*
 
@@ -216,7 +216,7 @@ openssl rsa -in key.pem -outform DER -out key.der
 
 server_name
 -----------
-**syntax:** `name, err = ssl.server_name()`
+**syntax:** *name, err = ssl.server_name()*
 
 **context:** *any*
 
@@ -240,7 +240,7 @@ This function can be called in whatever contexts where downstream https is used.
 
 raw_server_addr
 ---------------
-**syntax:** `addr_data, addr_type, err = ssl.raw_server_addr()`
+**syntax:** *addr_data, addr_type, err = ssl.raw_server_addr()*
 
 **context:** *any*
 
@@ -290,7 +290,7 @@ This function can be called in whatever contexts where downstream https is used.
 
 get_tls1_version
 ----------------
-**syntax:** `ver, err = ssl.get_tls1_version()`
+**syntax:** *ver, err = ssl.get_tls1_version()*
 
 **context:** *any*
 
