From patchwork Wed Jul 8 17:23:49 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 50904 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-wg0-f72.google.com (mail-wg0-f72.google.com [74.125.82.72]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id D0C4B213FD for ; Wed, 8 Jul 2015 17:24:35 +0000 (UTC) Received: by wgjx7 with SMTP id x7sf72094050wgj.3 for ; Wed, 08 Jul 2015 10:24:35 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:delivered-to:delivered-to:from:to:date :message-id:subject:precedence:list-id:list-unsubscribe:list-archive :list-post:list-help:list-subscribe:mime-version:content-type :content-transfer-encoding:errors-to:sender:x-original-sender :x-original-authentication-results:mailing-list; bh=eNbgsVKjE6xwDU435kWBqnafLv2/dzpD1EL65qmk474=; b=S+S+uu2oEB2bccwVWUA8Z16RohAe/L0aJzHWqmuYnL/TdPIHgUn0D4X0Ec56AiU+0N XmjiipbPRWx3/F4jxnvbVPUS79PyFeP/66QoS5UctC1Jc/c1sPgXf2WQVH5UdUljYCKY WQImGlKkWy43BITkfOmcy1+N3vlzNDSt3/B1M8K42CXVt2mWQdhyEE2wXY3wUYnF95/A /XiurNqhHPpSh8foYNcRBAy75so76RTzKI/WeHGR1ny8oTw3Gl02ZVndsLZh6649a4Ha MvNRiFMw0bBPOL2sK4UBMvuqp/w08dxVEQwzEhd1NeNjtcMUhMg6FaJMKCXiP4ybDTUQ 2peg== X-Gm-Message-State: ALoCoQkZK8Q1zydE5YMiu1TRzx1+ppVCT+TdbZRx98WHnQRyij7b44yvyC8FzGAhCMuJHitvXy0B X-Received: by 10.180.87.201 with SMTP id ba9mr21251718wib.3.1436376275168; Wed, 08 Jul 2015 10:24:35 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.205.6 with SMTP id lc6ls997767lac.80.gmail; Wed, 08 Jul 2015 10:24:35 -0700 (PDT) X-Received: by 10.152.37.196 with SMTP id a4mr10762470lak.59.1436376275003; Wed, 08 Jul 2015 10:24:35 -0700 (PDT) Received: from mail-lb0-f169.google.com (mail-lb0-f169.google.com. [209.85.217.169]) by mx.google.com with ESMTPS id qa2si2487986lbb.153.2015.07.08.10.24.34 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 08 Jul 2015 10:24:34 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.169 as permitted sender) client-ip=209.85.217.169; Received: by lbcpe5 with SMTP id pe5so60354536lbc.2 for ; Wed, 08 Jul 2015 10:24:34 -0700 (PDT) X-Received: by 10.152.37.228 with SMTP id b4mr10527528lak.117.1436376274566; Wed, 08 Jul 2015 10:24:34 -0700 (PDT) X-Forwarded-To: patchwork-forward@linaro.org X-Forwarded-For: patch@linaro.org patchwork-forward@linaro.org Delivered-To: patch@linaro.org Received: by 10.112.108.230 with SMTP id hn6csp102503lbb; Wed, 8 Jul 2015 10:24:33 -0700 (PDT) X-Received: by 10.140.100.146 with SMTP id s18mr7617855qge.36.1436376273385; Wed, 08 Jul 2015 10:24:33 -0700 (PDT) Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id 200si3493002qht.79.2015.07.08.10.24.03; Wed, 08 Jul 2015 10:24:33 -0700 (PDT) Received-SPF: pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) client-ip=54.225.227.206; Received: by lists.linaro.org (Postfix, from userid 109) id 1A40061F63; Wed, 8 Jul 2015 17:24:03 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on ip-10-142-244-252.ec2.internal X-Spam-Level: X-Spam-Status: No, score=-2.6 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_LOW, RCVD_IN_MSPIKE_H2, URIBL_BLOCKED autolearn=disabled version=3.4.0 Received: from ip-10-142-244-252.ec2.internal (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id 536F461F5A; Wed, 8 Jul 2015 17:23:59 +0000 (UTC) X-Original-To: lng-odp@lists.linaro.org Delivered-To: lng-odp@lists.linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id E5D0561F5D; Wed, 8 Jul 2015 17:23:56 +0000 (UTC) Received: from mail-qk0-f176.google.com (mail-qk0-f176.google.com [209.85.220.176]) by lists.linaro.org (Postfix) with ESMTPS id 4073661F54 for ; Wed, 8 Jul 2015 17:23:56 +0000 (UTC) Received: by qkbp125 with SMTP id p125so167934583qkb.2 for ; Wed, 08 Jul 2015 10:23:56 -0700 (PDT) X-Received: by 10.55.15.99 with SMTP id z96mr17824766qkg.75.1436376236043; Wed, 08 Jul 2015 10:23:56 -0700 (PDT) Received: from localhost.localdomain (c-98-221-136-245.hsd1.nj.comcast.net. [98.221.136.245]) by smtp.gmail.com with ESMTPSA id 188sm1674820qhh.48.2015.07.08.10.23.54 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 08 Jul 2015 10:23:55 -0700 (PDT) From: Mike Holmes To: lng-odp@lists.linaro.org Date: Wed, 8 Jul 2015 13:23:49 -0400 Message-Id: <1436376229-26127-1-git-send-email-mike.holmes@linaro.org> X-Mailer: git-send-email 2.1.4 X-Topics: patch Subject: [lng-odp] [PATCH] doc: doxygen: Add Converter function guidelines X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.16 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: , List-Help: , List-Subscribe: , MIME-Version: 1.0 Errors-To: lng-odp-bounces@lists.linaro.org Sender: "lng-odp" X-Removed-Original-Auth: Dkim didn't pass. X-Original-Sender: mike.holmes@linaro.org X-Original-Authentication-Results: mx.google.com; spf=pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.169 as permitted sender) smtp.mail=patch+caf_=patchwork-forward=linaro.org@linaro.org Mailing-list: list patchwork-forward@linaro.org; contact patchwork-forward+owners@linaro.org X-Google-Group-Id: 836684582541 Signed-off-by: Mike Holmes Reviewed-by: Bill Fischofer --- doc/api_guide_lines.dox | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/doc/api_guide_lines.dox b/doc/api_guide_lines.dox index f3f7799..c544afd 100644 --- a/doc/api_guide_lines.dox +++ b/doc/api_guide_lines.dox @@ -100,6 +100,16 @@ Another case might be if a packet has a vlan flag set Where possible returned information should be an enum if it reflects a finite list of information. In general get apis drop the actual tag "get" in the function name. +@subsection converter Converter Functions +To maintain efficiency in fastpath code converter functions should expect correct inputs with undefined results otherwise. + +@code +static inline odp_foo_t _odp_foo_from_bar(odp_bar_t bar) +{ + return (odp_foo_t)bar; +} +@endcode + @subsection function_calls Function Calls ODP APIs typically have prototypes of the form: