Return-Path: Delivered-To: apmail-harmony-dev-archive@www.apache.org Received: (qmail 41471 invoked from network); 20 Feb 2007 16:33:46 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.2) by minotaur.apache.org with SMTP; 20 Feb 2007 16:33:46 -0000 Received: (qmail 50769 invoked by uid 500); 20 Feb 2007 16:33:51 -0000 Delivered-To: apmail-harmony-dev-archive@harmony.apache.org Received: (qmail 50740 invoked by uid 500); 20 Feb 2007 16:33:51 -0000 Mailing-List: contact dev-help@harmony.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@harmony.apache.org Delivered-To: mailing list dev@harmony.apache.org Received: (qmail 50731 invoked by uid 99); 20 Feb 2007 16:33:51 -0000 Received: from herse.apache.org (HELO herse.apache.org) (140.211.11.133) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 20 Feb 2007 08:33:51 -0800 X-ASF-Spam-Status: No, hits=0.0 required=10.0 tests= X-Spam-Check-By: apache.org Received-SPF: pass (herse.apache.org: local policy) Received: from [143.182.124.21] (HELO mga03.intel.com) (143.182.124.21) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 20 Feb 2007 08:33:39 -0800 Received: from azsmga001.ch.intel.com ([10.2.17.19]) by mga03.intel.com with ESMTP; 20 Feb 2007 08:33:18 -0800 Received: from fmsmsx334.amr.corp.intel.com ([132.233.42.1]) by azsmga001.ch.intel.com with ESMTP; 20 Feb 2007 08:33:17 -0800 X-ExtLoop1: 1 X-IronPort-AV: i="4.14,197,1170662400"; d="scan'208"; a="184729648:sNHT323389297" Received: from nnsmsx411.ccr.corp.intel.com ([10.125.16.19]) by fmsmsx334.amr.corp.intel.com with Microsoft SMTPSVC(6.0.3790.1830); Tue, 20 Feb 2007 08:33:04 -0800 Content-class: urn:content-classes:message MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable X-MimeOLE: Produced By Microsoft Exchange V6.5 Subject: [doxygen][doc] commenting bkms draft published on wiki Date: Tue, 20 Feb 2007 19:33:00 +0300 Message-ID: <523F3D8D8C97554AA47E53DF1A05466AA1042B@nnsmsx411.ccr.corp.intel.com> X-MS-Has-Attach: X-MS-TNEF-Correlator: Thread-Topic: [doxygen][doc] commenting bkms draft published on wiki Thread-Index: AcdVDMjp/wq8ScHISrSeAiJJp8yOmw== From: "Morozova, Nadezhda" To: X-OriginalArrivalTime: 20 Feb 2007 16:33:04.0235 (UTC) FILETIME=[CB503BB0:01C7550C] X-Virus-Checked: Checked by ClamAV on apache.org Hi everyone, I have posted several tips/suggestions [1] about writing nice code comments in source header files for generating readable Doxygen reference materials [2]. These guidelines are to define some ground formatting and stylistic rules that would be good to follow when adding comments to code.=20 Your feedback is most welcome because together we can find the best solutions. The current reference documentation is often incomplete, out-of-date and/or not formatted correctly, which greatly decreases its usefulness. Volunteers are very welcome to supply patches with more commented code. The BKMs, samples and quoted bugs are mostly based on DRLVM materials, so classlib input is also welcomed. You can get involved in one of the following areas or open new JIRAs with your own suggestions/fixes: [3] improving formatting of code comments so that Doxygen parses them correctly [4] enabling creation of structurally meaningful doc bundles and adding intros (mainpage content) to each bundle [5] beautifying Doxygen output=20 [6] monitoring quality and quantity of available Doxygen documentation=20 Thanks,=20 Nadya Morozova [1] http://wiki.apache.org/harmony/Code_Commenting=20 [2] http://harmony.apache.org/subcomponents/drlvm/DoxygenStart.html=20 [3] https://issues.apache.org/jira/browse/HARMONY-2802=20 [4] https://issues.apache.org/jira/browse/HARMONY-2814=20 [5] http://wiki.apache.org/harmony/Doxygen_Docs_Look%26Feel_Improvements [6] http://wiki.apache.org/harmony/DRLVM_Documentation_Quality=20