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

Help

Home

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

Show: Today's Messages :: Show Polls :: Message Navigator

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

Mon, 16 July 2012 16:39

Zachary Lytle

Messages: 1
Registered: July 2012

Junior Member

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.

Report message to a moderator

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

Mon, 16 July 2012 18:08

R Shapiro

Messages: 386
Registered: June 2011

Senior Member

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.

Report message to a moderator

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

Mon, 16 July 2012 22:41

Robin Rosenberg

Messages: 332
Registered: July 2009

Senior Member

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

Report message to a moderator

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

Goto Forum:

-=] Back to Top [=-

[ Syndicate this forum (XML) ] [

]

Current Time: Mon Mar 30 00:25:16 GMT 2020

.:: Contact :: Home ::.

Breadcrumbs

Sign up to our Newsletter