Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleanup some warnings about \param lines in header files #80

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Cleanup some warnings about \param lines in header files #80

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions include/cjose/header.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ cjose_header_t *cjose_header_new(cjose_err *err);
* header will be used past the scope it was created in (e.g., from a
* `cjose_jws_t` object).
*
* \param header[in] the header object to be retained.
* \param header [in] the header object to be retained.
* \returns the retained header object
*/
cjose_header_t *cjose_header_retain(cjose_header_t *header);
Expand All @@ -120,17 +120,17 @@ cjose_header_t *cjose_header_retain(cjose_header_t *header);
* to dispose of header rather than directly free'ing a cjose_header
* object.
*
* \param header[in] the header object to be released.
* \param header [in] the header object to be released.
*/
void cjose_header_release(cjose_header_t *header);

/**
* Sets a header attribute on a header object. If that header was
* previously set, this will replace the previous value with the new one.
*
* \param header[in] a previously instantiated header object.
* \param attr[in] the header attribute to be set.
* \param value[in] the value to assign to the header attribute.
* \param header [in] a previously instantiated header object.
* \param attr [in] the header attribute to be set.
* \param value [in] the value to assign to the header attribute.
* \param err [out] An optional error object which can be used to get additional
* information in the event of an error.
* \returns true if header is successfully set.
Expand All @@ -141,8 +141,8 @@ bool cjose_header_set(cjose_header_t *header, const char *attr, const char *valu
* Retrieves the value of the requested header attribute from the header
* object.
*
* \param header[in] a header object.
* \param attr[in] the header attribute to be got.
* \param header [in] a header object.
* \param attr [in] the header attribute to be got.
* \param err [out] An optional error object which can be used to get additional
* information in the event of an error.
* \returns a string containing the current value for the requested attribute.
Expand All @@ -159,18 +159,18 @@ const char *cjose_header_get(cjose_header_t *header, const char *attr, cjose_err
* The input value must be a JSON serialized string. This function does not
* retain pointers to specified attribute or value.
*
* \param header[in] a previously instantiated header object.
* \param attr[in] the header attribute to be set.
* \param value[in] the JSON value to assign to the header attribute. The value must
* \param header [in] a previously instantiated header object.
* \param attr [in] the header attribute to be set.
* \param value [in] the JSON value to assign to the header attribute. The value must
* be a valid JSON, and will be assigned as is.
*/
bool cjose_header_set_raw(cjose_header_t *header, const char *attr, const char *value, cjose_err *err);

/**
* Retrieves the raw value of the requested header attribute from the header
* object.
* \param header[in] a header object.
* \param attr[in] the header attribute to be got.
* \param header [in] a header object.
* \param attr [in] the header attribute to be got.
* \param err [out] An optional error object which can be used to get additional
* information in the event of an error.
* \returns a string containing the current JSON value for the requested attribute.
Expand Down
2 changes: 1 addition & 1 deletion include/cjose/jwk.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ typedef struct
* \b NOTE: The caller MUST call cjose_jwk_release() to release the JWK's
* resources.
*
* \param size The keysize, in bits
* \param keysize The keysize, in bits
* \param e The public exponent
* \param elen The length of <tt>e</tt>
* \param err [out] An optional error object which can be used to get additional
Expand Down