From patchwork Tue Mar 17 18:57:19 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 45897 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-la0-f70.google.com (mail-la0-f70.google.com [209.85.215.70]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id AF41C21547 for ; Tue, 17 Mar 2015 18:57:49 +0000 (UTC) Received: by labgm9 with SMTP id gm9sf3466992lab.1 for ; Tue, 17 Mar 2015 11:57:48 -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: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=6J0gVeWxXctsCu1/5p8xffECHJIRyJddCHCSffxOOR8=; b=QmMnx5lYVDnkQPmhnaOBTikTS31gGk1HbdTYP662KSGsobyqN6dho4I/P6n0Oqs24j oAq2sAA5qUFNWx5JdzN2WHxu9lfYWEDMSkN5mexSNU97wiDzoo3UZ+htJUUoS7zGZbW4 QbArxlP418EM27hUPgMcn7IlgXpKBXasgd4CkpKtYhvG8nqgXmaHUBHMEoEPpuSfG5ua U9SVV6mD66e+v0YRV+Fa8PC4yeH+Kgzf/L2r3nfbHxRk2MZq+vDOxDg9yuT57LexjpNk 82hruwEG71kmQqgeI7R9DV2m1Uv44njU4vIdAEnD8u0VurKiO6zVdTd23aX+VaPUOeN6 Gmkw== X-Gm-Message-State: ALoCoQlk03FUZhjGpeelyxNzIczCVKRvDTh6FuyvMj2t+4gFw7aYFjmrDXb7RNTBjRxfsRrHTN7O X-Received: by 10.112.202.227 with SMTP id kl3mr3627448lbc.2.1426618668661; Tue, 17 Mar 2015 11:57:48 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.27.135 with SMTP id t7ls78489lag.45.gmail; Tue, 17 Mar 2015 11:57:48 -0700 (PDT) X-Received: by 10.112.51.35 with SMTP id h3mr51654138lbo.113.1426618668291; Tue, 17 Mar 2015 11:57:48 -0700 (PDT) Received: from mail-la0-f44.google.com (mail-la0-f44.google.com. [209.85.215.44]) by mx.google.com with ESMTPS id kt2si11181937lac.152.2015.03.17.11.57.48 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 17 Mar 2015 11:57:48 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.44 as permitted sender) client-ip=209.85.215.44; Received: by lamx15 with SMTP id x15so17023679lam.3 for ; Tue, 17 Mar 2015 11:57:48 -0700 (PDT) X-Received: by 10.112.8.101 with SMTP id q5mr55584639lba.19.1426618668195; Tue, 17 Mar 2015 11:57:48 -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.35.133 with SMTP id h5csp701530lbj; Tue, 17 Mar 2015 11:57:47 -0700 (PDT) X-Received: by 10.140.106.244 with SMTP id e107mr82673816qgf.0.1426618667004; Tue, 17 Mar 2015 11:57:47 -0700 (PDT) Received: from ip-10-35-177-41.ec2.internal (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTPS id a31si14174343qga.120.2015.03.17.11.57.45 (version=TLSv1 cipher=RC4-SHA bits=128/128); Tue, 17 Mar 2015 11:57:46 -0700 (PDT) Received-SPF: none (google.com: lng-odp-bounces@lists.linaro.org does not designate permitted sender hosts) client-ip=54.225.227.206; Received: from localhost ([127.0.0.1] helo=ip-10-35-177-41.ec2.internal) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1YXwgQ-00059E-2e; Tue, 17 Mar 2015 18:57:42 +0000 Received: from mail-qc0-f173.google.com ([209.85.216.173]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1YXwgJ-00057k-Rh for lng-odp@lists.linaro.org; Tue, 17 Mar 2015 18:57:35 +0000 Received: by qcyi15 with SMTP id i15so17955375qcy.0 for ; Tue, 17 Mar 2015 11:57:30 -0700 (PDT) X-Received: by 10.140.43.11 with SMTP id d11mr82136418qga.95.1426618650661; Tue, 17 Mar 2015 11:57:30 -0700 (PDT) Received: from mike-desktop.?.holmesfamily.ws (c-98-221-136-245.hsd1.nj.comcast.net. [98.221.136.245]) by mx.google.com with ESMTPSA id 201sm10167507qhr.24.2015.03.17.11.57.29 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 17 Mar 2015 11:57:30 -0700 (PDT) From: Mike Holmes To: lng-odp@lists.linaro.org Date: Tue, 17 Mar 2015 14:57:19 -0400 Message-Id: <1426618639-10009-1-git-send-email-mike.holmes@linaro.org> X-Mailer: git-send-email 2.1.0 X-Topics: patch Subject: [lng-odp] [PATCH] doc: doxygen: add declaring variables X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.14 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-bounces@lists.linaro.org 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.215.44 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 | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/doc/api_guide_lines.dox b/doc/api_guide_lines.dox index 4cfe088..2bc63a1 100644 --- a/doc/api_guide_lines.dox +++ b/doc/api_guide_lines.dox @@ -149,6 +149,21 @@ When an interface is defined in a header file and is intended to to be reused in - Be prefixed with an underscore "_". - All the required definitions for the API are to use an underscore, this includes MACROS, typedefs, enums and function names. +@subsection variables Declaring variables +- Variables shall be declared at the begining of scope, for example :- +@code + int start_of_global_scope; + + main () { + int start_of_function_scope; + ... + if (foo == bar) { + int start_of_block_scope; + ... + } + } +@endcode + @section implementation Implementation Considerations To support application portability and preserve implementation flexibility, ODP APIs MUST be designed with several guiding principles in mind.