From patchwork Tue Aug 26 12:05:20 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 35998 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-qc0-f198.google.com (mail-qc0-f198.google.com [209.85.216.198]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 9CE7E2054F for ; Tue, 26 Aug 2014 12:05:43 +0000 (UTC) Received: by mail-qc0-f198.google.com with SMTP id r5sf46022875qcx.9 for ; Tue, 26 Aug 2014 05:05:43 -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=9RUBUhZUGQ3jqakPRfTvktl6nzOkBqhK2bvi6/iVMSg=; b=GCJ1jn/rJMurIGRCQ+mFSb+tKxjhfY3jXie/6BTv41otAz9VXtbWCn3S2Ql2xqICyo Zo05FqtqbEa2fYziVN/lMnUNdGDoCdgT0kLgss6cV5iYigxxVltVnC09er1ELTffFjP0 sAl/4bml4VQhNDeCApgH6d7kyPdyGO9ujAlwiostU3Ruq+YjJE6ypnApQE1QMPnwgyeB goq27f9b59PgoVwFR5wwOYbjiEw3Q/NzvMfJSQewS+1XWpbOU5TjGU65GOCIW59vSd4c vN2LQAT2JasDdJFXs5ahL8cDusoreOD8I+y3HolYDxbsV2uiHvKRjqLP190Ba5N+4EQt z2lw== X-Gm-Message-State: ALoCoQkzVexFfLaie8mgJFW5yyVUq/SKk6pRCHnlxcKZSsEK4Un5O0DMwL2lrF4GfxuwpacYm0ni X-Received: by 10.236.83.171 with SMTP id q31mr4981341yhe.13.1409054743486; Tue, 26 Aug 2014 05:05:43 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.140.50.107 with SMTP id r98ls2593188qga.71.gmail; Tue, 26 Aug 2014 05:05:43 -0700 (PDT) X-Received: by 10.220.118.136 with SMTP id v8mr436801vcq.50.1409054743214; Tue, 26 Aug 2014 05:05:43 -0700 (PDT) Received: from mail-vc0-f171.google.com (mail-vc0-f171.google.com [209.85.220.171]) by mx.google.com with ESMTPS id v10si1273406vdt.16.2014.08.26.05.05.43 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Tue, 26 Aug 2014 05:05:43 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.220.171 as permitted sender) client-ip=209.85.220.171; Received: by mail-vc0-f171.google.com with SMTP id hq11so16697938vcb.16 for ; Tue, 26 Aug 2014 05:05:43 -0700 (PDT) X-Received: by 10.52.156.100 with SMTP id wd4mr9523848vdb.39.1409054743131; Tue, 26 Aug 2014 05:05:43 -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.45.67 with SMTP id uj3csp192854vcb; Tue, 26 Aug 2014 05:05:42 -0700 (PDT) X-Received: by 10.229.212.138 with SMTP id gs10mr44089105qcb.7.1409054742401; Tue, 26 Aug 2014 05:05:42 -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 u47si3604771qgd.10.2014.08.26.05.05.41 for (version=TLSv1 cipher=RC4-SHA bits=128/128); Tue, 26 Aug 2014 05:05:42 -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 1XMFVM-00079U-GE; Tue, 26 Aug 2014 12:05:40 +0000 Received: from mail-qg0-f53.google.com ([209.85.192.53]) by ip-10-141-164-156.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1XMFVG-00079P-68 for lng-odp@lists.linaro.org; Tue, 26 Aug 2014 12:05:34 +0000 Received: by mail-qg0-f53.google.com with SMTP id z60so10859183qgd.26 for ; Tue, 26 Aug 2014 05:05:29 -0700 (PDT) X-Received: by 10.140.42.195 with SMTP id c61mr33454795qga.54.1409054728825; Tue, 26 Aug 2014 05:05:28 -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 k4sm9081581qaf.0.2014.08.26.05.05.27 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 26 Aug 2014 05:05:28 -0700 (PDT) From: Mike Holmes To: lng-odp@lists.linaro.org Date: Tue, 26 Aug 2014 08:05:20 -0400 Message-Id: <1409054720-46473-1-git-send-email-mike.holmes@linaro.org> X-Mailer: git-send-email 1.9.1 X-Topics: patch Subject: [lng-odp] [PATCH v2] 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.171 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 --- v2: Add explicit text for the single line comment above macros etc. CONTRIBUTING | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/CONTRIBUTING b/CONTRIBUTING index 08887de..1372ed9 100644 --- a/CONTRIBUTING +++ b/CONTRIBUTING @@ -49,6 +49,32 @@ 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. The exception + to this rule is a case where the comment is very small, for example + /** macro description */ + #define SOME_MACRO 0 + + Commenting on the end of a line for macros and struct members is allowed using /**< */ for example + #define SOME_MACRO 0 /**< */ + + 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.