Docs: add @suppress to a few things that were polluting the Dokka docs.

This commit is contained in:
Mike Hearn 2017-09-26 18:56:08 +02:00
parent 6686b054a2
commit df453bdaa8
3 changed files with 5 additions and 2 deletions

View File

@ -235,11 +235,12 @@ fun <T> Class<T>.castIfPossible(obj: Any): T? = if (isInstance(obj)) cast(obj) e
fun <T> Class<*>.staticField(name: String): DeclaredField<T> = DeclaredField(this, name, null) fun <T> Class<*>.staticField(name: String): DeclaredField<T> = DeclaredField(this, name, null)
/** Returns a [DeclaredField] wrapper around the declared (possibly non-public) static field of the receiver [KClass]. */ /** Returns a [DeclaredField] wrapper around the declared (possibly non-public) static field of the receiver [KClass]. */
fun <T> KClass<*>.staticField(name: String): DeclaredField<T> = DeclaredField(java, name, null) fun <T> KClass<*>.staticField(name: String): DeclaredField<T> = DeclaredField(java, name, null)
/** Returns a [DeclaredField] wrapper around the declared (possibly non-public) instance field of the receiver object. */ /** @suppress Returns a [DeclaredField] wrapper around the declared (possibly non-public) instance field of the receiver object. */
fun <T> Any.declaredField(name: String): DeclaredField<T> = DeclaredField(javaClass, name, this) fun <T> Any.declaredField(name: String): DeclaredField<T> = DeclaredField(javaClass, name, this)
/** /**
* Returns a [DeclaredField] wrapper around the (possibly non-public) instance field of the receiver object, but declared * Returns a [DeclaredField] wrapper around the (possibly non-public) instance field of the receiver object, but declared
* in its superclass [clazz]. * in its superclass [clazz].
* @suppress
*/ */
fun <T> Any.declaredField(clazz: KClass<*>, name: String): DeclaredField<T> = DeclaredField(clazz.java, name, this) fun <T> Any.declaredField(clazz: KClass<*>, name: String): DeclaredField<T> = DeclaredField(clazz.java, name, this)

View File

@ -102,7 +102,8 @@ interface ServiceHub : ServicesForResolution {
val networkMapCache: NetworkMapCache val networkMapCache: NetworkMapCache
/** /**
* Provides verification service. The implementation may be a simple in-memory verify() call or perhaps an IPC/RPC. * INTERNAL. DO NOT USE.
* @suppress
*/ */
val transactionVerifierService: TransactionVerifierService val transactionVerifierService: TransactionVerifierService

View File

@ -5,6 +5,7 @@ import net.corda.core.transactions.LedgerTransaction
/** /**
* Provides verification service. The implementation may be a simple in-memory verify() call or perhaps an IPC/RPC. * Provides verification service. The implementation may be a simple in-memory verify() call or perhaps an IPC/RPC.
* @suppress
*/ */
interface TransactionVerifierService { interface TransactionVerifierService {
/** /**