Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

thunderbolt: Update property.c function documentation

Make property.c function documentation compliant with current kernel-doc
standards. No functional changes.

Signed-off-by: Alan Borzeszkowski <alan.borzeszkowski@linux.intel.com>
Signed-off-by: Mika Westerberg <mika.westerberg@linux.intel.com>

authored by

Alan Borzeszkowski and committed by
Mika Westerberg
d015642a a6e3f939

+28 -10
+28 -10
drivers/thunderbolt/property.c
··· 211 211 * 212 212 * This function parses the XDomain properties data block into format that 213 213 * can be traversed using the helper functions provided by this module. 214 - * Upon success returns the parsed directory. In case of error returns 215 - * %NULL. The resulting &struct tb_property_dir needs to be released by 214 + * 215 + * The resulting &struct tb_property_dir needs to be released by 216 216 * calling tb_property_free_dir() when not needed anymore. 217 217 * 218 218 * The @block is expected to be root directory. 219 + * 220 + * Return: Pointer to &struct tb_property_dir, %NULL in case of failure. 219 221 */ 220 222 struct tb_property_dir *tb_property_parse_dir(const u32 *block, 221 223 size_t block_len) ··· 240 238 * 241 239 * Creates new, empty property directory. If @uuid is %NULL then the 242 240 * directory is assumed to be root directory. 241 + * 242 + * Return: Pointer to &struct tb_property_dir, %NULL in case of failure. 243 243 */ 244 244 struct tb_property_dir *tb_property_create_dir(const uuid_t *uuid) 245 245 { ··· 485 481 * @block_len: Length of the property block 486 482 * 487 483 * This function formats the directory to the packed format that can be 488 - * then send over the thunderbolt fabric to receiving host. Returns %0 in 489 - * case of success and negative errno on faulure. Passing %NULL in @block 490 - * returns number of entries the block takes. 484 + * then sent over the thunderbolt fabric to receiving host. 485 + * 486 + * Passing %NULL in @block returns number of entries the block takes. 487 + * 488 + * Return: %0 on success, negative errno otherwise. 491 489 */ 492 490 ssize_t tb_property_format_dir(const struct tb_property_dir *dir, u32 *block, 493 491 size_t block_len) ··· 511 505 * tb_property_copy_dir() - Take a deep copy of directory 512 506 * @dir: Directory to copy 513 507 * 514 - * This function takes a deep copy of @dir and returns back the copy. In 515 - * case of error returns %NULL. The resulting directory needs to be 516 - * released by calling tb_property_free_dir(). 508 + * The resulting directory needs to be released by calling tb_property_free_dir(). 509 + * 510 + * Return: Pointer to &struct tb_property_dir, %NULL in case of failure. 517 511 */ 518 512 struct tb_property_dir *tb_property_copy_dir(const struct tb_property_dir *dir) 519 513 { ··· 583 577 * @parent: Directory to add the property 584 578 * @key: Key for the property 585 579 * @value: Immediate value to store with the property 580 + * 581 + * Return: %0 on success, negative errno otherwise. 586 582 */ 587 583 int tb_property_add_immediate(struct tb_property_dir *parent, const char *key, 588 584 u32 value) ··· 614 606 * @buflen: Number of bytes in the data buffer 615 607 * 616 608 * Function takes a copy of @buf and adds it to the directory. 609 + * 610 + * Return: %0 on success, negative errno otherwise. 617 611 */ 618 612 int tb_property_add_data(struct tb_property_dir *parent, const char *key, 619 613 const void *buf, size_t buflen) ··· 652 642 * @text: String to add 653 643 * 654 644 * Function takes a copy of @text and adds it to the directory. 645 + * 646 + * Return: %0 on success, negative errno otherwise. 655 647 */ 656 648 int tb_property_add_text(struct tb_property_dir *parent, const char *key, 657 649 const char *text) ··· 688 676 * @parent: Directory to add the property 689 677 * @key: Key for the property 690 678 * @dir: Directory to add 679 + * 680 + * Return: %0 on success, negative errno otherwise. 691 681 */ 692 682 int tb_property_add_dir(struct tb_property_dir *parent, const char *key, 693 683 struct tb_property_dir *dir) ··· 730 716 * @key: Key to look for 731 717 * @type: Type of the property 732 718 * 733 - * Finds and returns property from the given directory. Does not recurse 734 - * into sub-directories. Returns %NULL if the property was not found. 719 + * Finds and returns property from the given directory. Does not 720 + * recurse into sub-directories. 721 + * 722 + * Return: Pointer to &struct tb_property, %NULL if the property was not found. 735 723 */ 736 724 struct tb_property *tb_property_find(struct tb_property_dir *dir, 737 725 const char *key, enum tb_property_type type) ··· 753 737 * tb_property_get_next() - Get next property from directory 754 738 * @dir: Directory holding properties 755 739 * @prev: Previous property in the directory (%NULL returns the first) 740 + * 741 + * Return: Pointer to &struct tb_property, %NULL if property was not found. 756 742 */ 757 743 struct tb_property *tb_property_get_next(struct tb_property_dir *dir, 758 744 struct tb_property *prev)