Return-Path: 
 <commits-return-32538-apmail-harmony-commits-archive=harmony.apache.org@harmony.apache.org>
Delivered-To: apmail-harmony-commits-archive@www.apache.org
Received: (qmail 85348 invoked from network); 11 Apr 2007 06:30:54 -0000
Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.2)
  by minotaur.apache.org with SMTP; 11 Apr 2007 06:30:54 -0000
Received: (qmail 76427 invoked by uid 500); 11 Apr 2007 06:31:00 -0000
Delivered-To: apmail-harmony-commits-archive@harmony.apache.org
Received: (qmail 76213 invoked by uid 500); 11 Apr 2007 06:31:00 -0000
Mailing-List: contact commits-help@harmony.apache.org; run by ezmlm
Precedence: bulk
List-Help: <mailto:commits-help@harmony.apache.org>
List-Unsubscribe: <mailto:commits-unsubscribe@harmony.apache.org>
List-Post: <mailto:commits@harmony.apache.org>
List-Id: <commits.harmony.apache.org>
Reply-To: dev@harmony.apache.org
Delivered-To: mailing list commits@harmony.apache.org
Received: (qmail 76193 invoked by uid 99); 11 Apr 2007 06:30:59 -0000
Received: from herse.apache.org (HELO herse.apache.org) (140.211.11.133)
    by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 10 Apr 2007 23:30:59 -0700
X-ASF-Spam-Status: No, hits=-100.0 required=10.0
	tests=ALL_TRUSTED
X-Spam-Check-By: apache.org
Received: from [140.211.11.4] (HELO brutus.apache.org) (140.211.11.4)
    by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 10 Apr 2007 23:30:53 -0700
Received: from brutus (localhost [127.0.0.1])
	by brutus.apache.org (Postfix) with ESMTP id 9A3E3714071
	for <commits@harmony.apache.org>; Tue, 10 Apr 2007 23:30:32 -0700 (PDT)
Message-ID: <23047242.1176273032628.JavaMail.jira@brutus>
Date: Tue, 10 Apr 2007 23:30:32 -0700 (PDT)
From: "Svetlana Konovalova (JIRA)" <jira@apache.org>
To: commits@harmony.apache.org
Subject: [jira] Updated: (HARMONY-3284) [drlvm][doc] scarce comments in OS
 portability layer external interface headers
In-Reply-To: <23309769.1172832950807.JavaMail.jira@brutus>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 7bit
X-Virus-Checked: Checked by ClamAV on apache.org


     [ https://issues.apache.org/jira/browse/HARMONY-3284?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Svetlana Konovalova updated HARMONY-3284:
-----------------------------------------

    Attachment: 2include_headers.patch

2include_headers.patch corrects grammar and fixes formatting in include/open/compmgr.h  and include/component_manager.h 

Here are suggestions on further improvement:

include/open/compmgr.h  
- Define parameters as [in]/[out]
- Add member data documentation descriptions
-  not sure it should be this way:
        "instance - a handle of an instance to free" 
         Maybe <code>FREE</code>, or what?

component_manager.h 
- add brief/detailed descriptions
- define parameters as [in]/[out]

 Would be great if someone could take care of the aforementioned files.

Thanks in advance,
Sveta

 


> [drlvm][doc] scarce comments in OS portability layer external interface headers
> -------------------------------------------------------------------------------
>
>                 Key: HARMONY-3284
>                 URL: https://issues.apache.org/jira/browse/HARMONY-3284
>             Project: Harmony
>          Issue Type: Bug
>          Components: DRLVM
>            Reporter: Svetlana Konovalova
>         Attachments: 2include_headers.patch
>
>
> Many files lack ample and well-formatted comments; need to get easily readable, complete and useful reference for DRLVM Interface Reference and Java class library reference; the code commenting BKMs (http://wiki.apache.org/harmony/Code_Commenting) can be useful. Specific suggestions on improving Doxygen output are below.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.