Eclipse Community Forums: EGit / JGit » Code Style @version tag for revision history.

Home » Eclipse Projects » EGit / JGit » Code Style @version tag for revision history.

Code Style @version tag for revision history. [message #895964]

Mon, 16 July 2012 12:39

Eclipse User

Is there a way to have generated comments with an @version tag contain something useful from the commit/revision? Ideally, the abbreviated commit id would be added to any @version tag where changes were made, but anything more useful that the original date the comment was created would be great.

I'm very new to using anything more than shoving my workspace into Dropbox, so I understand if this is a newbie question that belongs elsewhere and apologise in advance.

Re: Code Style @version tag for revision history. [message #895982 is a reply to message #895964]

Mon, 16 July 2012 14:08

Eclipse User

What is it you really want to see? If you just want to know which commit last modified any given line in the file, Annotations will show you that. That seems cleaner to me than modifying the source.

Re: Code Style @version tag for revision history. [message #896016 is a reply to message #895964]

Mon, 16 July 2012 18:41

Eclipse User

Zachary Lytle skrev 2012-07-16 18.39:
> Is there a way to have generated comments with an @version tag contain
> something useful from the commit/revision? Ideally, the abbreviated
> commit id would be added to any @version tag where changes were made,
> but anything more useful that the original date the comment was created
> would be great.
> I'm very new to using anything more than shoving my workspace into
> Dropbox, so I understand if this is a newbie question that belongs
> elsewhere and apologise in advance.

The @version tag is for compatibility documentation and should (when
used) be populated with the OSGi version.

The PDE API analysis tools can help you do that for OSGi bundles.

-- robin

Previous Topic:	newbie import from git repository question
Next Topic:	Update site problem

Goto Forum:

-=] Back to Top [=-

Current Time: Sat Jun 14 00:32:59 EDT 2025

.:: Contact :: Home ::.

Breadcrumbs

Sign up to our Newsletter