[Hawkular-dev] eclipse config files available

[Peter Palaga]

Hi John,

hm... as it stands now, the @author tag is a part of the file comment. 
And when creating a new Java class/interface, it appears between the 
licese header and package declaration. Is this what you wanted?

I mean having @author in the type level JavaDoc comment is much more 
usual.  The type level JavaDoc is the one between imports and type 
declaration. WDYT?

= Example:

== Actual:

/*
  * Copyright 2014 - 2015 Red Hat, Inc. [...]
  */
/**
  *
  * @author ppalaga
  */
package org.hawkular.build.license;

/**
  *
  */
public class C {

}


== Expected:

/*
  * Copyright 2014 - 2015 Red Hat, Inc. [...]
  */
package org.hawkular.build.license;

/**
  *
  * @author ppalaga
  */
public class C {

}


-- Peter

On 01/16/2015 07:39 PM, Peter Palaga wrote:
> Hi John,
>
> thanks for the prefs.
>
> I pushed a small fix to the template containing the license header
> https://github.com/hawkular/hawkular-build-tools/commit/861c38e5a2c284a763ae41ec7130984062f0d144
>
>
> Besides that, I suppose @author ${user} [1] is not the prefered option
> for the most of us because ${user} resolves to the user name on the
> current machine.
> I found this [2] handy plugin that makes the values from Git config
> available in code template variables. So, I propose that we make this
> plugin recommended and that we change the template to something like
>
> * @author ${git_user_name:git_config(user.name)}
> ${git_user_email:git_config(user.email)}
>
> WDYT?
>
> Thanks,
>
> Peter
>
> [1]
> https://github.com/hawkular/hawkular-build-tools/blob/master/ide-configs/eclipse/hawkular-eclipse-preferences-java-codestyle-codetemplates.xml#L9
> [2] https://github.com/harmsk/eclipse-git-template-variables
>
> On 01/16/2015 06:38 PM, John Mazzitelli wrote:
>   > I committed some Eclipse config files in hawkular-build-tools (under
> ide-configs/eclipse) - see
> https://github.com/hawkular/hawkular-build-tools/tree/master/ide-configs/eclipse
>   >
>   > You import these into Eclipse to get formatting rules. These should
> be closely aligned to the checkstyle rules, but if they aren't 100%,
> feel free to commit fixes to them.
>   > _______________________________________________
>   > hawkular-dev mailing list
>   > hawkular-dev at lists.jboss.org
>   > https://lists.jboss.org/mailman/listinfo/hawkular-dev
>   >
> _______________________________________________
> hawkular-dev mailing list
> hawkular-dev at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/hawkular-dev
>