Proposed Annotation: @CopiedFrom

[mcherm]

First of all: wonderful annotation gallery!

I would like to propose an important new Remark Annotation to be added
to the collection: the CopiedFrom annotation.

For those times when you get things working by grabbing some snippet
of sample code from the net without quite understanding why it worked,
this annotation properly documents the source of the code:

@CopiedFrom(
source = "http://www.idevelopment.info/data/Programming/java/io/
HexConversions.java",
tested = false,
license = "Unknown")
public static String byteToHex(byte data) {
StringBuffer buf = new StringBuffer();
buf.append(toHexChar((data >>> 4) & 0x0F));
buf.append(toHexChar(data & 0x0F));
return buf.toString();
}

The source field is, of course, optional.

-----

I am open to suggestions: for instance, should the annotation be named
"CopiedFrom" or perhaps "StolenFrom" or simply "CutAndPaste". And I'll
be happy to provide implementation if the group likes the proposal.

-- Michael Chermside

[Leo Deegan]

Hi Michael -

Well, thanks, glad you like the gallery. Good suggestion. I sort of like the CutAndPaste name; it's a little more snarky. Or something like BrazenlyLifted. I'll try to add you as a contributor so you can get the implementation going.

--Leo

--
To unsubscribe, reply using "remove me" as the subject.

[Leo Deegan]

Hi Michael - We took a stab at adding this annotation and felt it
could potentially open up a slippery slope for folks. For instance,
the example you gave above came from copyrighted work. We might want
to think about this one a little more to make it less open-invite.