Skip to content
This repository has been archived by the owner on May 26, 2022. It is now read-only.

Commit

Permalink
fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
andriydruk committed Aug 22, 2016
1 parent 853982b commit 5d610c7
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 27 deletions.
4 changes: 2 additions & 2 deletions app/build.gradle
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
apply plugin: 'com.android.application'

android {
compileSdkVersion 23
compileSdkVersion 24
buildToolsVersion "24.0.0"

defaultConfig {
Expand All @@ -27,5 +27,5 @@ dependencies {
compile 'io.reactivex:rxandroid:1.1.0'
compile 'io.reactivex:rxjava:1.1.3'

compile 'com.android.support:appcompat-v7:23.3.0'
compile 'com.android.support:appcompat-v7:24.2.0'
}
Original file line number Diff line number Diff line change
Expand Up @@ -49,16 +49,13 @@ The numerical type of the resource record to be queried for (e.g. PTR, SRV, etc)
@param ttl
The time to live of the resource record, in seconds. Pass 0 to use a default value.
<P>
@param listener
This object will get called when the service is registered.
<P>
@return A {@link DNSSDService} that can be used to abort the record registration.
@throws SecurityException If a security manager is present and denies <tt>RuntimePermission("getDNSSDInstance")</tt>.
@see RuntimePermission
*/
public DNSRecord registerRecord(int flags, int ifIndex, String fullname, int rrtype,
int rrclass, byte[] rdata, int ttl)
int rrclass, byte[] rData, int ttl)
throws DNSSDException;
}

16 changes: 7 additions & 9 deletions library/src/main/java/com/github/druk/rxdnssd/RxDnssd.java
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,7 @@
import rx.Observable;

/**
* RxDnssd is reactive wrapper for DNSSD
*
* {@see com.apple.dnssd.DNSSD}
* RxDnssd is reactive wrapper for {@link com.apple.dnssd.DNSSD}
*/
public interface RxDnssd {

Expand All @@ -36,13 +34,13 @@ public interface RxDnssd {
* Most applications will not specify a domain, instead browsing on the
* default domain(s).
* <P>
* @return A {@link Observable<BonjourService>} that represents the active browse operation.
* @return A {@link Observable} that represents the active browse operation.
*/
@NonNull
Observable<BonjourService> browse(@NonNull final String regType, @NonNull final String domain);

/**
* Resolve a {@link Observable<BonjourService>} to a target host name, port number, and txt record.<P>
* Resolve a {@link Observable} to a target host name, port number, and txt record.<P>
*
* Note: Applications should NOT use resolve() solely for txt record monitoring - use
* queryRecord() instead, as it is more efficient for this task.<P>
Expand All @@ -51,31 +49,31 @@ public interface RxDnssd {
* a single TXT record (the TXT record may be empty.) To resolve non-standard services with
* multiple SRV or TXT records, use queryRecord().<P>
*
* @return A {@link Observable.Transformer<BonjourService, BonjourService>} that transform not resolved object to resolved.
* @return A {@link Observable.Transformer} that transform not resolved object to resolved.
*/
@NonNull
Observable.Transformer<BonjourService, BonjourService> resolve();

/**
* Query ipv4 and ipv6 addresses
*
* @return A {@link Observable.Transformer<BonjourService, BonjourService>} that transform object without addresses to object with addresses.
* @return A {@link Observable.Transformer} that transform object without addresses to object with addresses.
*/
@NonNull
Observable.Transformer<BonjourService, BonjourService> queryRecords();

/**
* Query ipv4 address
*
* @return A {@link Observable.Transformer<BonjourService, BonjourService>} that transform object without address to object with address.
* @return A {@link Observable.Transformer} that transform object without address to object with address.
*/
@NonNull
Observable.Transformer<BonjourService, BonjourService> queryIPV4Records();

/**
* Query ipv6 address
*
* @return A {@link Observable.Transformer<BonjourService, BonjourService>} that transform object without address to object with address.
* @return A {@link Observable.Transformer} that transform object without address to object with address.
*/
@NonNull
Observable.Transformer<BonjourService, BonjourService> queryIPV6Records();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,7 @@
import rx.functions.Action1;

/**
* RxDnssdBindable is implementation of RxDnssd with system's daemon
*
* {@see com.apple.dnssd.DNSSD}
* RxDnssdBindable is implementation of RxDnssd with system's daemon {@link com.apple.dnssd.DNSSD}
*/
@TargetApi(Build.VERSION_CODES.JELLY_BEAN)
public class RxDnssdBindable extends RxDnssdCommon {
Expand Down
12 changes: 6 additions & 6 deletions library/src/main/java/com/github/druk/rxdnssd/RxDnssdCommon.java
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ abstract class RxDnssdCommon implements RxDnssd {
* Most applications will not specify a domain, instead browsing on the
* default domain(s).
* <P>
* @return A {@link Observable <BonjourService>} that represents the active browse operation.
* @return A {@link Observable} that represents the active browse operation.
*/
@NonNull
@Override
Expand All @@ -48,7 +48,7 @@ public DNSSDService getService(Subscriber<? super BonjourService> subscriber) th
}

/**
* Resolve a {@link Observable<BonjourService>} to a target host name, port number, and txt record.<P>
* Resolve a {@link Observable} to a target host name, port number, and txt record.<P>
*
* Note: Applications should NOT use resolve() solely for txt record monitoring - use
* queryRecord() instead, as it is more efficient for this task.<P>
Expand All @@ -57,7 +57,7 @@ public DNSSDService getService(Subscriber<? super BonjourService> subscriber) th
* a single TXT record (the TXT record may be empty.) To resolve non-standard services with
* multiple SRV or TXT records, use queryRecord().<P>
*
* @return A {@link Observable.Transformer<BonjourService, BonjourService>} that transform not resolved object to resolved.
* @return A {@link Observable.Transformer} that transform not resolved object to resolved.
*/
@NonNull
@Override
Expand Down Expand Up @@ -87,7 +87,7 @@ public DNSSDService getService(Subscriber<? super BonjourService> subscriber) th
/**
* Query ipv4 and ipv6 addresses
*
* @return A {@link Observable.Transformer<BonjourService, BonjourService>} that transform object without addresses to object with addresses.
* @return A {@link Observable.Transformer} that transform object without addresses to object with addresses.
*/
@NonNull
@Override
Expand Down Expand Up @@ -124,7 +124,7 @@ public DNSSDService getService(Subscriber<? super BonjourService> subscriber) th
/**
* Query ipv4 address
*
* @return A {@link Observable.Transformer<BonjourService, BonjourService>} that transform object without address to object with address.
* @return A {@link Observable.Transformer} that transform object without address to object with address.
*/
@NonNull
@Override
Expand Down Expand Up @@ -154,7 +154,7 @@ public DNSSDService getService(Subscriber<? super BonjourService> subscriber) th
/**
* Query ipv6 address
*
* @return A {@link Observable.Transformer<BonjourService, BonjourService>} that transform object without address to object with address.
* @return A {@link Observable.Transformer} that transform object without address to object with address.
*/
@NonNull
@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,7 @@
import rx.functions.Action1;

/**
* RxDnssd is implementation of RxDnssd with embedded DNS-SD
*
* {@see com.apple.dnssd.DNSSD}
* RxDnssd is implementation of RxDnssd with embedded DNS-SD {@link com.apple.dnssd.DNSSD}
*/
public class RxDnssdEmbedded extends RxDnssdCommon {

Expand Down

0 comments on commit 5d610c7

Please sign in to comment.