mirror of
https://github.com/openssl/openssl.git
synced 2024-12-09 05:51:54 +08:00
bbecf04e78
Details from man-pages(7) that are used:
Formatting conventions for manual pages describing functions
...
Variable names should, like argument names, be specified in italics.
...
Formatting conventions (general)
...
Special macros, which are usually in uppercase, are in bold.
Exception: don't boldface NULL.
...
Furthermore, for TYPE used as a placeholder for types and correponding
part of function names, we extrapolate that it's both a type and a
variable, and should therefore be bold (typical for types and function
names) and italic (typical for variables). POD processors don'e know
this, so we have to help them along. Therefore:
SPARSE_ARRAY_OF(TYPE) => B<SPARSE_ARRAY_OF>(B<I<TYPE>>)
ossl_sa_TYPE_num() => B<ossl_sa_I<TYPE>_num>()
TYPE => B<I<TYPE>>
There are some other less typical uses where one simply has to give
formatting some extra though.
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/10041)
|
||
|---|---|---|
| .. | ||
| cms_add1_signing_cert.pod | ||
| DEFINE_SPARSE_ARRAY_OF.pod | ||
| evp_generic_fetch.pod | ||
| evp_keymgmt_export_to_provider.pod | ||
| evp_keymgmt_freekey.pod | ||
| openssl_ctx_get_data.pod | ||
| ossl_algorithm_do_all.pod | ||
| ossl_cmp_asn1_octet_string_set1.pod | ||
| ossl_cmp_ctx_set1_caPubs.pod | ||
| ossl_cmp_sk_X509_add1_cert.pod | ||
| ossl_init_thread_deregister.pod | ||
| ossl_method_construct.pod | ||
| OSSL_METHOD_STORE.pod | ||
| ossl_namemap_new.pod | ||
| ossl_param_bld_init.pod | ||
| ossl_prov_util_nid_to_name.pod | ||
| ossl_provider_add_conf_module.pod | ||
| ossl_provider_new.pod | ||
| rand_bytes_ex.pod | ||