From harmony-dev-return-17876-apmail-incubator-harmony-dev-archive=incubator.apache.org@incubator.apache.org Wed Nov 01 18:17:43 2006 Return-Path: Delivered-To: apmail-incubator-harmony-dev-archive@www.apache.org Received: (qmail 8015 invoked from network); 1 Nov 2006 18:17:42 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.2) by minotaur.apache.org with SMTP; 1 Nov 2006 18:17:42 -0000 Received: (qmail 2716 invoked by uid 500); 1 Nov 2006 18:17:50 -0000 Delivered-To: apmail-incubator-harmony-dev-archive@incubator.apache.org Received: (qmail 2681 invoked by uid 500); 1 Nov 2006 18:17:50 -0000 Mailing-List: contact harmony-dev-help@incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: harmony-dev@incubator.apache.org Delivered-To: mailing list harmony-dev@incubator.apache.org Received: (qmail 2672 invoked by uid 99); 1 Nov 2006 18:17:50 -0000 Received: from herse.apache.org (HELO herse.apache.org) (140.211.11.133) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 01 Nov 2006 10:17:50 -0800 X-ASF-Spam-Status: No, hits=2.0 required=10.0 tests=RCVD_IN_BL_SPAMCOP_NET X-Spam-Check-By: apache.org Received-SPF: pass (herse.apache.org: local policy) Received: from [192.55.52.88] (HELO mga01.intel.com) (192.55.52.88) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 01 Nov 2006 10:17:33 -0800 Received: from fmsmga001.fm.intel.com ([10.253.24.23]) by mga01.intel.com with ESMTP; 01 Nov 2006 10:17:13 -0800 Received: from fmsmsx333.amr.corp.intel.com ([132.233.42.2]) by fmsmga001.fm.intel.com with ESMTP; 01 Nov 2006 10:13:25 -0800 X-ExtLoop1: 1 X-IronPort-AV: i="4.09,379,1157353200"; d="scan'208"; a="155979656:sNHT60426282" Received: from fmsmsx311.amr.corp.intel.com ([132.233.42.214]) by fmsmsx333.amr.corp.intel.com with Microsoft SMTPSVC(6.0.3790.1830); Wed, 1 Nov 2006 10:13:25 -0800 Received: from nnsmsx411.ccr.corp.intel.com ([10.125.16.19]) by fmsmsx311.amr.corp.intel.com with Microsoft SMTPSVC(6.0.3790.1830); Wed, 1 Nov 2006 10:13:24 -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: RE: [doc] No Doxygen reference for code :( Date: Wed, 1 Nov 2006 21:13:20 +0300 Message-ID: <523F3D8D8C97554AA47E53DF1A05466A588048@nnsmsx411.ccr.corp.intel.com> X-MS-Has-Attach: X-MS-TNEF-Correlator: Thread-Topic: [doc] No Doxygen reference for code :( Thread-Index: Acb91t6jjqKQ6uXsSpadVTaTa/xyGwACohNA From: "Morozova, Nadezhda" To: X-OriginalArrivalTime: 01 Nov 2006 18:13:24.0891 (UTC) FILETIME=[6C0D2EB0:01C6FDE1] X-Virus-Checked: Checked by ClamAV on apache.org +1 Thank you,=20 Nadya Morozova =20 -----Original Message----- From: Paulex Yang [mailto:paulex.yang@gmail.com]=20 Sent: Wednesday, November 01, 2006 7:55 PM To: harmony-dev@incubator.apache.org Subject: Re: [doc] No Doxygen reference for code :( Alexey Petrenko wrote: > I think that we can place the docs here: > http://incubator.apache.org/harmony/subcomponents/classlibrary/index.htm l Yes, that's one of my candidate, another one is here:=20 standard/site/docs/documentation/documentation.html, because I think it=20 is also a reasonable idea for the user to go for "documentation" if you=20 wanna some API explanation. How about we put the API document in each=20 subcomponents(classlib/drlvm/jchevm), but also add their link in=20 documentation/documentation.html? > > 2006/11/1, Paulex Yang : >> Morozova, Nadezhda wrote: >> > Hi everyone, >> > >> > I've noticed that there's no API reference documentation for Harmony >> > code - generated by Doxygen/Javadoc. I guess many will agree that >> > having API reference is very useful and convenient. >> > >> > >> > >> > This issue was discussed a while ago [1] for kernel classes and vmi >> > interface in classlib. We agreed to store the Doxygen docs on the >> > website by generating them manually from code and placing there. It >> > seems that the old version of the docs was removed from SVN but never >> > made its way to the website, so it's just NOWHERE now :-(. Let's=20 >> fix it! >> > >> > >> > AFAIU, we want to have the following: >> > >> > 1. Ability to generate docs locally from source code as part of >> > build - need to change existing build files or write new ones. >> > 2. Ability to see docs on the website - manually copy a local >> > bundle of docs to the website and add a link. Geir has been=20 >> planning to >> > include the website into the next snapshot; supplying ready reference >> > with it seem nice. >> > >> > Volunteers? >> >> > I can work on item 2 for sure to get a nice config file and patch the >> > website to link to our new Doxygen API. Item 1 -fixing the build -=20 >> might >> > be more extravagant, so your aid's welcome ;) >> > >> It is me that removed the original document in classlib/trunk/doc as we >> discussed before, so seems it should be my responsibility to make the >> work complete:). Sorry for delaying so long. But I still have no strong >> feelings where to put them in standard/site, any suggestions? >> >> You can create all the API document by run "ant" in classlib/trunk/doc, >> you can get all document created, assuming Doxygen is installed. If you >> kindly provide the patch, I will look at it and merge it into SVN. >> > >> > >> > [1] mail thread >> >=20 >> http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200609.mb >> > ox/%3c591B455B-186D-43B4-8F9D-D5A0EA52A38D@pobox.com%3e >> > >> > >> > >> > Thanks, >> > >> > Nadya Morozova >> > >> > >> > >> >> >> --=20 >> Paulex Yang >> China Software Development Lab >> IBM >> >> >> > --=20 Paulex Yang China Software Development Lab IBM