From patchwork Wed Dec 16 17:11:13 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mauro Carvalho Chehab X-Patchwork-Id: 7864021 Return-Path: X-Original-To: patchwork-linux-media@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork1.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.136]) by patchwork1.web.kernel.org (Postfix) with ESMTP id B4F009F387 for ; Wed, 16 Dec 2015 17:11:52 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id A2265201EC for ; Wed, 16 Dec 2015 17:11:47 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 59FFA201EF for ; Wed, 16 Dec 2015 17:11:45 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S965959AbbLPRLl (ORCPT ); Wed, 16 Dec 2015 12:11:41 -0500 Received: from bombadil.infradead.org ([198.137.202.9]:41333 "EHLO bombadil.infradead.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S934276AbbLPRLh (ORCPT ); Wed, 16 Dec 2015 12:11:37 -0500 Received: from [191.33.142.179] (helo=smtp.w2.samsung.com) by bombadil.infradead.org with esmtpsa (Exim 4.80.1 #2 (Red Hat Linux)) id 1a9Fc0-0007Bx-QF; Wed, 16 Dec 2015 17:11:37 +0000 Received: from mchehab by smtp.w2.samsung.com with local (Exim 4.86) (envelope-from ) id 1a9Fbg-0005Lu-PQ; Wed, 16 Dec 2015 15:11:16 -0200 From: Mauro Carvalho Chehab Cc: Mauro Carvalho Chehab , Linux Media Mailing List , Mauro Carvalho Chehab Subject: [PATCH 3/5] [media] media-entity.h fix documentation for several parameters Date: Wed, 16 Dec 2015 15:11:13 -0200 Message-Id: X-Mailer: git-send-email 2.5.0 In-Reply-To: <6c927d1218bd10ccb3a0e8d727e153f0b5798603.1450285867.git.mchehab@osg.samsung.com> References: <6c927d1218bd10ccb3a0e8d727e153f0b5798603.1450285867.git.mchehab@osg.samsung.com> In-Reply-To: <6c927d1218bd10ccb3a0e8d727e153f0b5798603.1450285867.git.mchehab@osg.samsung.com> References: <6c927d1218bd10ccb3a0e8d727e153f0b5798603.1450285867.git.mchehab@osg.samsung.com> To: unlisted-recipients:; (no To-header on input) Sender: linux-media-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-media@vger.kernel.org X-Spam-Status: No, score=-6.9 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_HI, T_RP_MATCHES_RCVD, UNPARSEABLE_RELAY autolearn=unavailable version=3.3.1 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on mail.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP Several parameters added by the media_ent_enum patches were declared with wrong argument names: include/media/media-device.h:333: warning: No description found for parameter 'entity_internal_idx_max' include/media/media-device.h:354: warning: No description found for parameter 'ent_enum' include/media/media-device.h:354: warning: Excess function parameter 'e' description in 'media_entity_enum_init' include/media/media-device.h:333: warning: No description found for parameter 'entity_internal_idx_max' include/media/media-device.h:354: warning: No description found for parameter 'ent_enum' include/media/media-device.h:354: warning: Excess function parameter 'e' description in 'media_entity_enum_init' include/media/media-entity.h:397: warning: No description found for parameter 'ent_enum' include/media/media-entity.h:397: warning: Excess function parameter 'e' description in 'media_entity_enum_zero' include/media/media-entity.h:409: warning: No description found for parameter 'ent_enum' include/media/media-entity.h:409: warning: Excess function parameter 'e' description in 'media_entity_enum_set' include/media/media-entity.h:424: warning: No description found for parameter 'ent_enum' include/media/media-entity.h:424: warning: Excess function parameter 'e' description in 'media_entity_enum_clear' include/media/media-entity.h:441: warning: No description found for parameter 'ent_enum' include/media/media-entity.h:441: warning: Excess function parameter 'e' description in 'media_entity_enum_test' include/media/media-entity.h:458: warning: No description found for parameter 'ent_enum' include/media/media-entity.h:458: warning: Excess function parameter 'e' description in 'media_entity_enum_test_and_set' include/media/media-entity.h:474: warning: No description found for parameter 'ent_enum' include/media/media-entity.h:474: warning: Excess function parameter 'e' description in 'media_entity_enum_empty' include/media/media-entity.h:474: warning: Excess function parameter 'entity' description in 'media_entity_enum_empty' include/media/media-entity.h:489: warning: No description found for parameter 'ent_enum1' include/media/media-entity.h:489: warning: No description found for parameter 'ent_enum2' include/media/media-entity.h:489: warning: Excess function parameter 'e' description in 'media_entity_enum_intersects' include/media/media-entity.h:489: warning: Excess function parameter 'f' description in 'media_entity_enum_intersects' Fix them. Signed-off-by: Mauro Carvalho Chehab --- include/media/media-device.h | 6 ++++-- include/media/media-entity.h | 24 ++++++++++++------------ 2 files changed, 16 insertions(+), 14 deletions(-) diff --git a/include/media/media-device.h b/include/media/media-device.h index 4b900c9c5cdd..aa8ec40c3a0e 100644 --- a/include/media/media-device.h +++ b/include/media/media-device.h @@ -279,7 +279,9 @@ struct device; * @pad_id: Unique ID used on the last pad registered * @link_id: Unique ID used on the last link registered * @intf_devnode_id: Unique ID used on the last interface devnode registered - * @entity_internal_idx: Allocated internal entity indices + * @entity_internal_idx: Unique internal entity ID used by the graph traversal + * algorithms + * @entity_internal_idx_max: Allocated internal entity indices * @entities: List of registered entities * @interfaces: List of registered interfaces * @pads: List of registered pads @@ -344,7 +346,7 @@ struct media_device { /** * media_entity_enum_init - Initialise an entity enumeration * - * @e: Entity enumeration to be initialised + * @ent_enum: Entity enumeration to be initialised * @mdev: The related media device * * Returns zero on success or a negative error code. diff --git a/include/media/media-entity.h b/include/media/media-entity.h index f90ff56888d4..855b47df6ed5 100644 --- a/include/media/media-entity.h +++ b/include/media/media-entity.h @@ -391,7 +391,7 @@ void media_entity_enum_cleanup(struct media_entity_enum *ent_enum); /** * media_entity_enum_zero - Clear the entire enum * - * @e: Entity enumeration to be cleared + * @ent_enum: Entity enumeration to be cleared */ static inline void media_entity_enum_zero(struct media_entity_enum *ent_enum) { @@ -401,7 +401,7 @@ static inline void media_entity_enum_zero(struct media_entity_enum *ent_enum) /** * media_entity_enum_set - Mark a single entity in the enum * - * @e: Entity enumeration + * @ent_enum: Entity enumeration * @entity: Entity to be marked */ static inline void media_entity_enum_set(struct media_entity_enum *ent_enum, @@ -416,7 +416,7 @@ static inline void media_entity_enum_set(struct media_entity_enum *ent_enum, /** * media_entity_enum_clear - Unmark a single entity in the enum * - * @e: Entity enumeration + * @ent_enum: Entity enumeration * @entity: Entity to be unmarked */ static inline void media_entity_enum_clear(struct media_entity_enum *ent_enum, @@ -431,7 +431,7 @@ static inline void media_entity_enum_clear(struct media_entity_enum *ent_enum, /** * media_entity_enum_test - Test whether the entity is marked * - * @e: Entity enumeration + * @ent_enum: Entity enumeration * @entity: Entity to be tested * * Returns true if the entity was marked. @@ -448,13 +448,14 @@ static inline bool media_entity_enum_test(struct media_entity_enum *ent_enum, /** * media_entity_enum_test - Test whether the entity is marked, and mark it * - * @e: Entity enumeration + * @ent_enum: Entity enumeration * @entity: Entity to be tested * * Returns true if the entity was marked, and mark it before doing so. */ -static inline bool media_entity_enum_test_and_set( - struct media_entity_enum *ent_enum, struct media_entity *entity) +static inline bool +media_entity_enum_test_and_set(struct media_entity_enum *ent_enum, + struct media_entity *entity) { if (WARN_ON(entity->internal_idx >= ent_enum->idx_max)) return true; @@ -463,10 +464,9 @@ static inline bool media_entity_enum_test_and_set( } /** - * media_entity_enum_test - Test whether the entire enum is empty + * media_entity_enum_empty - Test whether the entire enum is empty * - * @e: Entity enumeration - * @entity: Entity to be tested + * @ent_enum: Entity enumeration * * Returns true if the entity was marked. */ @@ -478,8 +478,8 @@ static inline bool media_entity_enum_empty(struct media_entity_enum *ent_enum) /** * media_entity_enum_intersects - Test whether two enums intersect * - * @e: First entity enumeration - * @f: Second entity enumeration + * @ent_enum1: First entity enumeration + * @ent_enum2: Second entity enumeration * * Returns true if entity enumerations e and f intersect, otherwise false. */