DESCRIPTION

Initial work to add javadoc to Oprofile

Change-Id: I8f71670eb96dc79f0f54535841cec90d67623309


COMMENTS

author: Melanie Brock
date: 2013-04-26 20:12:24.000000000

Uploaded patch set 2.

-------------------------------------
author: Brenden Conley
date: 2013-04-26 20:12:30.000000000

Patch Set 2:

Build Started https://hudson.eclipse.org/sandbox/job/linuxtools/2085/ 

-------------------------------------
author: Brenden Conley
date: 2013-04-26 20:28:09.000000000

Patch Set 2: Verified

Build Successful 

https://hudson.eclipse.org/sandbox/job/linuxtools/2085/ : SUCCESS

-------------------------------------
author: Nathanael Holden
date: 2013-04-29 20:07:00.000000000

Patch Set 2: I would prefer that you didn't submit this

(6 inline comments)



Line:94, oprofile/org.eclipse.linuxtools.oprofile.core/src/org/eclipse/linuxtools/internal/oprofile/core/IOpcontrolProvider.java -> Make sure to remove the extraneous whitespace, in other places as well.

Line:43, oprofile/org.eclipse.linuxtools.oprofile.core/src/org/eclipse/linuxtools/internal/oprofile/core/opxml/modeldata/SamplesProcessor.java -> Javadoc can be inherrited from base class (XMLProcessor).

Line:29, oprofile/org.eclipse.linuxtools.oprofile.core/src/org/eclipse/linuxtools/internal/oprofile/core/OprofileProperties.java -> This is essentially an auto-generated class to help with internationalization so it doesn't really need to be documented.

Line:247, oprofile/org.eclipse.linuxtools.oprofile.core/src/org/eclipse/linuxtools/internal/oprofile/core/linux/LinuxOpcontrolProvider.java -> the argument and return type should be explained.

Line:291, oprofile/org.eclipse.linuxtools.oprofile.core/src/org/eclipse/linuxtools/internal/oprofile/core/linux/LinuxOpcontrolProvider.java -> This isn't just the arguments to the command, but the full command. A small distinction but worth clarifying.

Line:62, oprofile/org.eclipse.linuxtools.oprofile.core/src/org/eclipse/linuxtools/internal/oprofile/core/opxml/modeldata/ModelDataProcessor.java -> There's no need to add descriptions for methods that are being overriden in this way. We should get the javadoc from the base method. You could add xxx@xxx.xxx annotation linking to the class/method. if you wish.

-------------------------------------
