added javadoc for blame line pre processor api

This commit is contained in:
Sebastian Sdorra
2012-06-27 15:16:34 +02:00
parent fdd7ae4000
commit 09b04278f7
2 changed files with 10 additions and 5 deletions

View File

@@ -37,6 +37,8 @@ package sonia.scm.repository;
import sonia.scm.plugin.ExtensionPoint;
/**
* A pre processor for {@link BlameLine} objects. A pre processor is able to
* modify the object before it is delivered to the user interface.
*
* @author Sebastian Sdorra
* @since 1.17
@@ -46,10 +48,10 @@ public interface BlameLinePreProcessor extends PreProcessor<BlameLine>
{
/**
* Method description
* Process the given blame line.
*
*
* @param blameLine
* @param blameLine blame line to process.
*/
@Override
public void process(BlameLine blameLine);

View File

@@ -30,6 +30,7 @@
*/
package sonia.scm.repository;
//~--- non-JDK imports --------------------------------------------------------
@@ -37,6 +38,8 @@ package sonia.scm.repository;
import sonia.scm.plugin.ExtensionPoint;
/**
* The BlameLinePreProcessorFactory create {@link BlameLinePreProcessor}
* objects for a specific repository.
*
* @author Sebastian Sdorra
* @since 1.17
@@ -47,12 +50,12 @@ public interface BlameLinePreProcessorFactory
{
/**
* Method description
* Create a new {@link BlameLinePreProcessor} for the given repository.
*
*
* @param repository
* @param repository repository
*
* @return
* @return {@link BlameLinePreProcessor} for the given repository
*/
@Override
public BlameLinePreProcessor createPreProcessor(Repository repository);