Mailing-List: contact commits-help@harmony.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@harmony.apache.org
Message-ID: <12766696.1178609115738.JavaMail.jira@brutus>
Date: Tue, 8 May 2007 00:25:15 -0700 (PDT)
From: "Svetlana Konovalova (JIRA)" <jira@apache.org>
To: commits@harmony.apache.org
Subject: [jira] Updated: (HARMONY-2802) [drlvm][doc]Improve documentation
 autogenerated from DRLVM sources.
In-Reply-To: <14506002.1166550741054.JavaMail.jira@brutus>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 7bit


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

Svetlana Konovalova updated HARMONY-2802:
-----------------------------------------

    Attachment: 3portFiles.patch
                H-2802Port.patch

Nadya,
Trying to apply H-2802Port.patch, I found out three conflicting files: enc_defs.h, enc_prvt.h and port_vmem.h. Resolving this problem, I removed the aforementioned files from H-2802Port.patch, fixed them and created 3portFiles.patch for them.
I tested both patches (updated H-2802Port.patch + 3portFiles.patch ) and they seem to be fine, hope you'll commit them without problems.
Please let me know if you have any questions.
Cheers,
Sveta


> [drlvm][doc]Improve documentation autogenerated from DRLVM sources.
> -------------------------------------------------------------------
>
>                 Key: HARMONY-2802
>                 URL: https://issues.apache.org/jira/browse/HARMONY-2802
>             Project: Harmony
>          Issue Type: Improvement
>          Components: DRLVM
>            Reporter: Svetlana Konovalova
>         Assigned To: Nadya Morozova
>         Attachments: 3portFiles.patch, build_fix.patch, DRLVMheadersPatch2.patch, green.headers.patch, H-2802Port.patch, H-2802Port.patch, HeadersPatch3.patch, port.headers.patch, PortHeaderFiles_update_February,9.patch, VMCoreHeaders.patch
>
>
> I've created the patch to fix formatting in the following files located in include/ folder: vm.h, vm_util.h, jit_import_rt.h, common.h, jit_runtime_support.h, hycomp.h, ee_em_intf.h. Please be aware i've only fixed format of comments. Please find my comments on how to improve the same headers further: 
> common.h
> -Add detailed description 
> -Add brief description [@file]
>  
> ee_em_intf.h
> -Are there any [OUT] parameters?
>  
> hycomp.h
> -Add detailed description 
> -Add brief description [@file]
> -Add Defines and Typedefs descriptions (where necessary)
> -There is the list of functions( or whatever) defining  HY_PLATFORM_DOUBLE_ORDER 
> I'm not sure they should be documented the way they are now... 
> -Use @note for note text, but not just NOTE
>  
> jit_import_rt.h 
> -Seems to be fine
>  
>  
> jit_runtime_support.h
> -Add detailed description 
> -Add brief description [@file]
> -Document functions, enums, typedefs (where the description is missing)
> -Use @note for note text, but not just NOTE
> -Group related functionalities together 
> [Object creation routines; Exception throwing routines; Type access routines; Deprecated routines;etc
> ]
>  using \ingroup, \defgroup, \addtogroup [<http://www.stack.nl/~dimitri/doxygen/grouping.html> 
> ]
> -Use @return, @param where necessary 
>  
>   
> vm.h
> -Add detailed description 
> -Add brief description [@file]
> -Document certain classes, defines, functions, enums, typedefs (where the description is missing)
> -Use \ingroup, \defgroup to get rid of such notes as: begin class iterator related functions;
>   end class-related functions; end class-related functions; end method signature-related functions
> -Define parameters as [in]/[out]
> -Use @return & @note (I've added some...)
>  
> vm_util.h 
> -Add detailed description 
> -Add brief description [@file]
> -Document functions,classes, variables, typedefs(where the description is missing)
> -Can use \ingroup, \defgroup
> -Define parameters as [in]/[out]
>  
>   

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