javadoc fixes for the upstream cybergarage UPnP library. Upstream ticket #3598391 has been filed for this issue.

This commit is contained in:
kytv
2012-12-24 19:44:25 +00:00
parent 1d0f8b4c6d
commit 420ccad91b
8 changed files with 10 additions and 27 deletions

View File

@@ -121,7 +121,7 @@ public class HTTPServer implements Runnable
/**
* Set the current socket timeout
* @param longout new timeout
* @param timeout
* @since 1.8
*/
public synchronized void setTimeout(int timeout) {

View File

@@ -122,9 +122,8 @@ public class HostInterface
*
* @param ipfilter
* @param interfaces
* @return
* @return InetAddress[]
* @since 1.8.0
* @author Stefano "Kismet" Lenzi <kismet.sl@gmail.com>
*/
public final static InetAddress[] getInetAddress(int ipfilter,String[] interfaces){
Enumeration nis;

View File

@@ -50,8 +50,6 @@ public class AllowedValue
* and will create the Node structure by itself
*
* @param value The value that will be associate to thi object
*
* @author Stefano "Kismet" Lenzi - kismet-sl@users.sourceforge.net - 2005
*/
public AllowedValue(String value) {

View File

@@ -395,7 +395,6 @@ public class Device implements org.cybergarage.http.HTTPRequestListener, SearchL
*
* @return A Device that contain this object.<br>
* Return <code>null</code> if this is a root device.
* @author Stefano "Kismet" Lenzi
*/
public Device getParentDevice() {
if(isRootDevice())
@@ -428,9 +427,6 @@ public class Device implements org.cybergarage.http.HTTPRequestListener, SearchL
* Device withtout writing any XML that describe the device<br>.
*
* @param d Add Device d to the Device
*
* @author Stefano "Kismet" Lenzi - kismet-sl@users.sourceforge.net - 2005
*
*/
public void addDevice(Device d) {
Node deviceListNode = getDeviceNode().getNode(DeviceList.ELEM_NAME);
@@ -1553,7 +1549,7 @@ public class Device implements org.cybergarage.http.HTTPRequestListener, SearchL
/**
*
* @return
* @return SSDPIPv4MulticastAddress
* @since 1.8
*/
public String getSSDPIPv4MulticastAddress(){
@@ -1571,7 +1567,7 @@ public class Device implements org.cybergarage.http.HTTPRequestListener, SearchL
/**
*
* @return
* @return SSDPIPv6MulticastAddress
* @since 1.8
*/
public String getSSDPIPv6MulticastAddress(){

View File

@@ -851,8 +851,6 @@ public class Service
* Note: that no control for duplicate StateVariable is done.
*
* @param var StateVariable that will be added
*
* @author Stefano "Kismet" Lenzi - kismet-sl@users.sourceforge.net - 2005
*/
public void addStateVariable(StateVariable var) {
//TODO Some test are done not stable

View File

@@ -271,8 +271,6 @@ public class StateVariable extends NodeData
* the last set will be the only present<br>
*
* @param avl The new AllowedValueList
*
* @author Stefano "Kismet" Lenzi - kismet-sl@users.sourceforge.net - 2005
*/
public void setAllowedValueList(AllowedValueList avl) {
//TODO Some test done not stable
@@ -320,8 +318,6 @@ public class StateVariable extends NodeData
* the last set will be the only present<br>
*
* @param avr The new AllowedValueRange
*
* @author Stefano "Kismet" Lenzi - kismet-sl@users.sourceforge.net - 2005
*/
public void setAllowedValueRange(AllowedValueRange avr){
//TODO Some test done not stable
@@ -439,8 +435,6 @@ public class StateVariable extends NodeData
////////////////////////////////////////////////
/**
* Get the value of DefaultValue of this StateVariable
*
* @author Stefano Lenzi kismet-sl@users.sourceforge.net
*/
public String getDefaultValue() {
return getStateVariableNode().getNodeValue(DEFAULT_VALUE);
@@ -453,8 +447,6 @@ public class StateVariable extends NodeData
* Device withtout writing any XML that describe the device<br>.
*
* @param value The new String value
*
* @author Stefano Lenzi kismet-sl@users.sourceforge.net
*/
public void setDefaultValue(String value){
getStateVariableNode().setNode(DEFAULT_VALUE,value);

View File

@@ -60,7 +60,7 @@ public class SSDPSearchSocket extends HTTPMUSocket implements Runnable
/**
*
* @param bindAddr the binding address for senging multicast packet
* @param bindAddr the binding address for sending multicast packet
* @since 1.8
*/
public SSDPSearchSocket(InetAddress bindAddr){
@@ -97,9 +97,9 @@ public class SSDPSearchSocket extends HTTPMUSocket implements Runnable
/**
*
* @param bindAddr the hostname of the interface to use for senfing multicast packet
* @param bindAddr the hostname of the interface to use for sending multicast packet
* @return true if and only if it open the socket
* @see {@link SSDP} for default multicast and port destination of the packtes
* @see org.cybergarage.upnp.ssdp for default multicast and port destination of the packets
*/
public boolean open(String bindAddr)
{

View File

@@ -180,9 +180,9 @@ public class DeviceData extends NodeData
*
* @param inets The <tt>InetAddress</tt> that will be binded for listing this service.
* Use <code>null</code> for the default behaviur.
* @see {@link UPnP}
* @see {@link USSDP}
* @see {@link HostInterface}
* @see org.cybergarage.upnp.ssdp
* @see org.cybergarage.upnp
* @see org.cybergarage.net.HostInterface
* @since 1.8
*/
public void setSSDPBindAddress(InetAddress[] inets){