incubator-droids-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Eugen Paraschiv (JIRA)" <j...@apache.org>
Subject [jira] Updated: (DROIDS-123) Better formatting consistency for the Droids codebase
Date Sun, 20 Feb 2011 11:34:38 GMT

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

Eugen Paraschiv updated DROIDS-123:
-----------------------------------

    Description: 
The formatting in droids should effectively be the same as the standard Java Conventions build
in Eclipse formatter. However, the are multiple formatting inconsistencies in the droids codebas.

Examples: 
1. braces
- SimpleTaskQueue - even in the same class, there are cases where the opening braces are on
the same line as the method signature: 
public T next() {
and cases where they are not: 
public void clear()
  {

2. whitespace 
- sometimes there is a whitespace between a 'for' and the '('
for (
and sometimes there is not: 
for(

The proposal to deal with this is to start with the Java build in formatter in Eclipse (with
a few minor changes), and format the entire droids codebase - the changes should be minor
in most cases. 

  was:
There is a severe lack of consistency regarding formatting in the codebase. 
Example - SimpleTaskQueue - even in the same class, there are cases where the opening braces
are on the same line as the method signature: 
public T next() {
and cases where they are not: 
public void clear()
  {

A very simple solution for this is using the standard Eclipse (or Sun) formatter to provide
a level of consistency. 
A better solution is to commit a formatter along with the code (as it is standard practice).
 


> Better formatting consistency for the Droids codebase 
> ------------------------------------------------------
>
>                 Key: DROIDS-123
>                 URL: https://issues.apache.org/jira/browse/DROIDS-123
>             Project: Droids
>          Issue Type: Improvement
>          Components: core
>    Affects Versions: 0.0.2
>            Reporter: Eugen Paraschiv
>             Fix For: 0.0.2
>
>
> The formatting in droids should effectively be the same as the standard Java Conventions
build in Eclipse formatter. However, the are multiple formatting inconsistencies in the droids
codebas. 
> Examples: 
> 1. braces
> - SimpleTaskQueue - even in the same class, there are cases where the opening braces
are on the same line as the method signature: 
> public T next() {
> and cases where they are not: 
> public void clear()
>   {
> 2. whitespace 
> - sometimes there is a whitespace between a 'for' and the '('
> for (
> and sometimes there is not: 
> for(
> The proposal to deal with this is to start with the Java build in formatter in Eclipse
(with a few minor changes), and format the entire droids codebase - the changes should be
minor in most cases. 

-- 
This message is automatically generated by JIRA.
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

Mime
View raw message