[vlma-devel] commit: Fix Javadoc warnings. (Adrien Grand )
git version control
git at videolan.org
Thu Aug 14 00:16:11 CEST 2008
vlma | branch: master | Adrien Grand <jpountz at videolan.org> | Tue Aug 12 22:22:38 2008 +0200| [7255035a9b650f2781edbc9f45fdaf67f230869b] | committer: Adrien Grand
Fix Javadoc warnings.
> http://git.videolan.org/gitweb.cgi/vlma.git/?a=commit;h=7255035a9b650f2781edbc9f45fdaf67f230869b
---
vlma-api/src/main/java/org/videolan/vlma/Data.java | 11 +++++------
.../org/videolan/vlma/model/media/Program.java | 9 +++------
.../src/main/java/org/videolan/vlma/DataImpl.java | 2 +-
.../main/java/org/videolan/vlma/VLMaService.java | 14 +++++++-------
.../java/org/videolan/vlma/VLMaServiceImpl.java | 2 +-
.../main/java/org/videolan/vlma/daemon/Daemon.java | 2 +-
.../main/java/org/videolan/vlma/daemon/VLMad.java | 2 +-
7 files changed, 19 insertions(+), 23 deletions(-)
diff --git a/vlma-api/src/main/java/org/videolan/vlma/Data.java b/vlma-api/src/main/java/org/videolan/vlma/Data.java
index 7cb9991..9bee993 100644
--- a/vlma-api/src/main/java/org/videolan/vlma/Data.java
+++ b/vlma-api/src/main/java/org/videolan/vlma/Data.java
@@ -103,7 +103,7 @@ public interface Data extends Remote {
* Sets the property value associated with a given key.
*
* @param key the property key
- * @param property the property value to set
+ * @param value the property value to set
* @throws RemoteException
*/
void setProperty(String key, Object value) throws RemoteException;
@@ -152,9 +152,9 @@ public interface Data extends Remote {
void add(Satellite satellite) throws SatelliteAlreadyExistsException, RemoteException;
/**
- * Synchronized the database with the provided satellite.
+ * Synchronize the database with the provided satellite.
*
- * @param name the satellite name
+ * @param satellite the satellite to update
* @throws SatelliteAlreadyExistsException
* The provided satellite is not in the database.
* @throws RemoteException
@@ -184,7 +184,7 @@ public interface Data extends Remote {
* Returns a satellite according to its ID.
*
* @see Server
- * @see Server#ID()
+ * @see Server#getId()
* @param server the server ID
* @return the server
* @throws ServerDoesNotExistException
@@ -197,7 +197,7 @@ public interface Data extends Remote {
* Create a server.
*
* @see Server
- * @param name the server name
+ * @param server the server to add to the database
* @throws ServerAlreadyExistsException
* Another server has already that name.
* @throws RemoteException
@@ -307,7 +307,6 @@ public interface Data extends Remote {
/**
* Executes orders.
*
- * @see OrderGiver
* @throws RemoteException
*/
void giveOrders() throws RemoteException;
diff --git a/vlma-api/src/main/java/org/videolan/vlma/model/media/Program.java b/vlma-api/src/main/java/org/videolan/vlma/model/media/Program.java
index 0eb96a1..2bab9b5 100644
--- a/vlma-api/src/main/java/org/videolan/vlma/model/media/Program.java
+++ b/vlma-api/src/main/java/org/videolan/vlma/model/media/Program.java
@@ -201,13 +201,10 @@ public class Program implements Serializable {
/**
* Tells whether the media of the order is really broadcasted.
*
- * @param broadcastState
- * The brocast state :
- * True if the media is broadcast
- * False if not
+ * @param broadcastState true if the media is broadcasted, false otherwise
*/
- public void setBroadcastState(boolean broadcastStateGiven) {
- broadcastState = broadcastStateGiven;
+ public void setBroadcastState(boolean broadcastState) {
+ this.broadcastState = broadcastState;
}
/**
diff --git a/vlma-core/src/main/java/org/videolan/vlma/DataImpl.java b/vlma-core/src/main/java/org/videolan/vlma/DataImpl.java
index fd31062..99a8e66 100644
--- a/vlma-core/src/main/java/org/videolan/vlma/DataImpl.java
+++ b/vlma-core/src/main/java/org/videolan/vlma/DataImpl.java
@@ -413,7 +413,7 @@ public class DataImpl implements Data {
/**
* Sets the configuration.
*
- * @param daemon the configuration to set
+ * @param configuration the configuration to set
*/
public void setConfiguration(Configuration configuration) {
this.configuration = configuration;
diff --git a/vlma-core/src/main/java/org/videolan/vlma/VLMaService.java b/vlma-core/src/main/java/org/videolan/vlma/VLMaService.java
index e52d6b7..2575595 100644
--- a/vlma-core/src/main/java/org/videolan/vlma/VLMaService.java
+++ b/vlma-core/src/main/java/org/videolan/vlma/VLMaService.java
@@ -39,37 +39,37 @@ import org.videolan.vlma.model.media.Satellite;
public interface VLMaService {
/**
- * @see Data#getSatellites()
+ * @see org.videolan.vlma.Data#getSatellites()
*/
List<Satellite> getSatellites();
/**
- * @see Data#getServers()
+ * @see org.videolan.vlma.Data#getServers()
*/
List<Server> getServers();
/**
- * @see Data#getMedias()
+ * @see org.videolan.vlma.Data#getMedias()
*/
List<Media> getMedias();
/**
- * @see Data#getOrders()
+ * Returns the set of orders that should be executed.
*/
Set<Order> getOrders();
/**
- * @see Data#giveOrders()
+ * @see org.videolan.vlma.Data#giveOrders()
*/
void giveOrders();
/**
- * @see Data#startOrderMonitoring()
+ * @see org.videolan.vlma.Data#startOrderMonitoring()
*/
void startOrderMonitoring();
/**
- * @see Data#startCheckAllVLCs()
+ * @see org.videolan.vlma.Data#startCheckAllVLCs()
*/
void startCheckAllVLCs();
diff --git a/vlma-core/src/main/java/org/videolan/vlma/VLMaServiceImpl.java b/vlma-core/src/main/java/org/videolan/vlma/VLMaServiceImpl.java
index 481b4fe..a840fa6 100644
--- a/vlma-core/src/main/java/org/videolan/vlma/VLMaServiceImpl.java
+++ b/vlma-core/src/main/java/org/videolan/vlma/VLMaServiceImpl.java
@@ -317,7 +317,7 @@ public class VLMaServiceImpl implements VLMaService {
/**
* Sets the server state monitor.
*
- * @param serverMonitor the server state monitor to set
+ * @param serverStateMonitor the server state monitor to set
*/
public void setServerStateMonitor(ServerStateMonitor serverStateMonitor) {
this.serverStateMonitor = serverStateMonitor;
diff --git a/vlma-core/src/main/java/org/videolan/vlma/daemon/Daemon.java b/vlma-core/src/main/java/org/videolan/vlma/daemon/Daemon.java
index 06d74b7..17df79a 100644
--- a/vlma-core/src/main/java/org/videolan/vlma/daemon/Daemon.java
+++ b/vlma-core/src/main/java/org/videolan/vlma/daemon/Daemon.java
@@ -83,7 +83,7 @@ public class Daemon {
/**
* Sets the VLMa DAO.
*
- * @param vlmaService the vlmaDao to set
+ * @param vlmaDao the vlmaDao to set
*/
public void setVlmaDao(VLMaDao vlmaDao) {
this.vlmaDao = vlmaDao;
diff --git a/vlma-daemon/src/main/java/org/videolan/vlma/daemon/VLMad.java b/vlma-daemon/src/main/java/org/videolan/vlma/daemon/VLMad.java
index 5aa216f..a907448 100644
--- a/vlma-daemon/src/main/java/org/videolan/vlma/daemon/VLMad.java
+++ b/vlma-daemon/src/main/java/org/videolan/vlma/daemon/VLMad.java
@@ -41,7 +41,7 @@ import org.videolan.vlma.Data;
* The VLMa daemon launcher. This class contains the boot process of VLMA
* software.
*
- * @see Daemon
+ * @see org.videolan.vlma.daemon.Daemon
* @author Sylvain Cadilhac <sylv at videolan.org>
*/
public class VLMad {
More information about the vlma-devel
mailing list