diff options
| author | Richard Levitte <levitte@openssl.org> | 2019-09-28 08:07:18 +0200 |
|---|---|---|
| committer | Richard Levitte <levitte@openssl.org> | 2019-10-01 22:31:30 +0200 |
| commit | 723e9c8983f92bc256a7e8677cc02f05b47e227c (patch) | |
| tree | f3fef2a633b61bfc9f2d6c1244bfe77556ecaacc /doc/man3/ASN1_OBJECT_new.pod | |
| parent | e8769719c9bbe53d7af088111b7625671660d4db (diff) | |
Make ASN1 manuals conform with man-pages(7)
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.
...
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/10042)
Diffstat (limited to 'doc/man3/ASN1_OBJECT_new.pod')
| -rw-r--r-- | doc/man3/ASN1_OBJECT_new.pod | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/man3/ASN1_OBJECT_new.pod b/doc/man3/ASN1_OBJECT_new.pod index 2ea9a44095..4e1a3740ea 100644 --- a/doc/man3/ASN1_OBJECT_new.pod +++ b/doc/man3/ASN1_OBJECT_new.pod @@ -13,23 +13,23 @@ ASN1_OBJECT_new, ASN1_OBJECT_free - object allocation functions =head1 DESCRIPTION -The ASN1_OBJECT allocation routines, allocate and free an -ASN1_OBJECT structure, which represents an ASN1 OBJECT IDENTIFIER. +The B<ASN1_OBJECT> allocation routines, allocate and free an +B<ASN1_OBJECT> structure, which represents an ASN1 OBJECT IDENTIFIER. -ASN1_OBJECT_new() allocates and initializes an ASN1_OBJECT structure. +ASN1_OBJECT_new() allocates and initializes an B<ASN1_OBJECT> structure. -ASN1_OBJECT_free() frees up the B<ASN1_OBJECT> structure B<a>. -If B<a> is NULL, nothing is done. +ASN1_OBJECT_free() frees up the B<ASN1_OBJECT> structure I<a>. +If I<a> is NULL, nothing is done. =head1 NOTES -Although ASN1_OBJECT_new() allocates a new ASN1_OBJECT structure it +Although ASN1_OBJECT_new() allocates a new B<ASN1_OBJECT> structure it is almost never used in applications. The ASN1 object utility functions such as OBJ_nid2obj() are used instead. =head1 RETURN VALUES -If the allocation fails, ASN1_OBJECT_new() returns B<NULL> and sets an error +If the allocation fails, ASN1_OBJECT_new() returns NULL and sets an error code that can be obtained by L<ERR_get_error(3)>. Otherwise it returns a pointer to the newly allocated structure. |