Dokka: How can I hide data-class generated methods?

Created on 23 May 2016  路  6Comments  路  Source: Kotlin/dokka

I am looking for a way to remove componentX() and copy(...) methods of a data class from my Dokka generated Javadoc. Is there a way to do that?

Most helpful comment

Well, nobody likes boilerplate documentation, so you could consider adding a tag for hiding methods, e.g. @exclude copy, component*.

All 6 comments

There is no way to do that. The Dokka-generated Javadoc shows the actual Java API of your Kotlin class, which does include the copy() and componentX() methods.

Well, nobody likes boilerplate documentation, so you could consider adding a tag for hiding methods, e.g. @exclude copy, component*.

@exclude copy, component*

Where should one put it?
I tried to put it in class documentation, but it did not work.
/**
* An icon placed at a particular point on the map's surface.
* @param position GeoPoint at which marker will be set.
* @exclude copy, component*
*/
data class Marker(val position: GeoPoint)

@RenegadesLabs It was proposed but never implemented

@semoro Ok, thanks for answer! Really need this feature...

Can you please elaborate as to why there is no way to do that ? Is there no way to do it in dokka or is somewhere else that things are missing ?

Was this page helpful?
0 / 5 - 0 ratings

Related issues

simonbasle picture simonbasle  路  4Comments

martinkocjan-tomtom picture martinkocjan-tomtom  路  6Comments

gabrielittner picture gabrielittner  路  3Comments

norswap picture norswap  路  4Comments

rbares picture rbares  路  4Comments