From patchwork Mon Aug 18 13:03:02 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 35491 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-pa0-f69.google.com (mail-pa0-f69.google.com [209.85.220.69]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id E4A4020676 for ; Mon, 18 Aug 2014 13:03:35 +0000 (UTC) Received: by mail-pa0-f69.google.com with SMTP id kx10sf43967337pab.8 for ; Mon, 18 Aug 2014 06:03:28 -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:errors-to:sender :x-original-sender:x-original-authentication-results:mailing-list :content-type:content-transfer-encoding; bh=0R0OTRV768RhSh5XgsGnKXFES5EpMZFCMqif//+qYxY=; b=aUuA7BWloG8pmAfO2NDttSsWQNmRxKgGYZnZSDF6S2G3Krinv1Js0TcqIGT10K1Ary KYvpv+GlYmQpsdA0NXBaEEvznUZZ2pZcn7lvQjFSaL1G/oGhH+hCm7IXa13K+0lCICUf tMF+MD+vzYo+R2iQDXQDQP42FnaurwhCBagJw/pcJBhqQMlmLDMv1vMi4zKPhIOaDFxP /dej+WSxWrt5GAWg/SnINu+XnKQiWAt4AAzsXIxvx0AWYXnhHo2kGKSmtjc0bVi5DB1e SVD0TZSYZlPgwsSTLkpFsHw5b9BnfvylFp0iL3M3UX8tRwGbQy4M1UQZpvSHrSK1nkKN LcoA== X-Gm-Message-State: ALoCoQnEwkZXx9jO55Kz+kFR3lZrTYB27xbAO07bYr4dHjgEcPclOlDqbJeQJROYmoYVSNg2nkXr X-Received: by 10.66.66.3 with SMTP id b3mr17561707pat.6.1408367005778; Mon, 18 Aug 2014 06:03:25 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.140.98.99 with SMTP id n90ls1886150qge.66.gmail; Mon, 18 Aug 2014 06:03:25 -0700 (PDT) X-Received: by 10.52.245.101 with SMTP id xn5mr7626154vdc.32.1408367005650; Mon, 18 Aug 2014 06:03:25 -0700 (PDT) Received: from mail-vc0-f170.google.com (mail-vc0-f170.google.com [209.85.220.170]) by mx.google.com with ESMTPS id o3si5458690veo.7.2014.08.18.06.03.25 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Mon, 18 Aug 2014 06:03:25 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.220.170 as permitted sender) client-ip=209.85.220.170; Received: by mail-vc0-f170.google.com with SMTP id lf12so5766543vcb.1 for ; Mon, 18 Aug 2014 06:03:25 -0700 (PDT) X-Received: by 10.220.80.82 with SMTP id s18mr157628vck.57.1408367005552; Mon, 18 Aug 2014 06:03:25 -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.221.37.5 with SMTP id tc5csp150362vcb; Mon, 18 Aug 2014 06:03:25 -0700 (PDT) X-Received: by 10.229.53.134 with SMTP id m6mr35331122qcg.19.1408367005033; Mon, 18 Aug 2014 06:03:25 -0700 (PDT) Received: from ip-10-141-164-156.ec2.internal (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTPS id s68si23986584qge.17.2014.08.18.06.03.24 for (version=TLSv1 cipher=RC4-SHA bits=128/128); Mon, 18 Aug 2014 06:03:25 -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-141-164-156.ec2.internal) by ip-10-141-164-156.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1XJMap-0005Bj-VL; Mon, 18 Aug 2014 13:03:23 +0000 Received: from mail-qc0-f172.google.com ([209.85.216.172]) by ip-10-141-164-156.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1XJMaj-0005Be-T9 for lng-odp@lists.linaro.org; Mon, 18 Aug 2014 13:03:17 +0000 Received: by mail-qc0-f172.google.com with SMTP id i8so4724678qcq.17 for ; Mon, 18 Aug 2014 06:03:12 -0700 (PDT) X-Received: by 10.224.86.5 with SMTP id q5mr56382683qal.36.1408366992458; Mon, 18 Aug 2014 06:03:12 -0700 (PDT) Received: from fedora1.holmesfamily.ws (c-98-221-136-245.hsd1.nj.comcast.net. [98.221.136.245]) by mx.google.com with ESMTPSA id y70sm18549498qgd.3.2014.08.18.06.03.11 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Mon, 18 Aug 2014 06:03:11 -0700 (PDT) From: Mike Holmes To: lng-odp@lists.linaro.org Date: Mon, 18 Aug 2014 09:03:02 -0400 Message-Id: <1408366982-14102-1-git-send-email-mike.holmes@linaro.org> X-Mailer: git-send-email 1.9.1 X-Topics: patch Subject: [lng-odp] [PATCH] CONTRIBUTING: Add doxygen commenting rules 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.220.170 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 --- CONTRIBUTING | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/CONTRIBUTING b/CONTRIBUTING index 08887de..91e2aa9 100644 --- a/CONTRIBUTING +++ b/CONTRIBUTING @@ -49,6 +49,19 @@ compiler: Please ensure submitted patches are checkpatch clean before submitting them to avoid having them automatically returned for rework. +Documenting the code + +Allow doxygen to use all its default behaviors to identify tagged information but where a doxygen tag must be specified use @ +The first line is by default the brief summary. +The next paragraph is by default the detailed summary +Normal comment sections should be before the code block and start with /** on its own line and finish with */ on its own line. +Commenting on the end of a line for #defines and struct members is allowed using /**< */ +Files should start with a files description using @file +Functions should specify their parameters with @param[in] and @param[out] +Functions return values should all be specified using @return +There should be no doxygen warnings or errors generated. + + [1] https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/CodingStyle [2] https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/SubmittingPatches [3] refer to README file.