dokka 如何设置 visibility

时间: 2023-07-04 20:26:21 浏览: 43
在 Dokka 中,你可以使用 `@since` 标签来设置文档元素的可见性。`@since` 标签可以接受一个可见性修饰符作为参数,例如 `public`、`protected`、`private` 或 `internal`,这样可以控制文档元素的可见性。 下面是一个示例,假设你有一个类 `MyClass`,你想将其设置为 `internal` 可见性: ``` /** * @since internal */ class MyClass { // ... } ``` 在上面的示例中,我们在类的文档注释中使用 `@since` 标签来设置类的可见性为 `internal`。这样,在生成的文档中,Dokka 就会将该类标记为 `internal`。 除了 `@since` 标签外,你还可以使用其他一些标签来设置文档元素的可见性,例如 `@public`、`@protected` 和 `@private`。这些标签与 `@since` 标签的作用相同,只不过更加明确。
相关问题

如何让 dokka 在文档中不添加父类的函数

如果你想让 Dokka 在生成文档时不包含父类的函数,可以使用 Dokka 的 `@suppress` 标签。具体来说,你可以在子类中使用 `@suppress` 标签,将父类中的函数或属性标记为被抑制的元素,从而在文档中不显示它们。 下面是一个示例,假设你有一个父类 `BaseClass` 和一个子类 `DerivedClass`,你想在 `DerivedClass` 中隐藏 `BaseClass` 中的 `foo()` 函数: ``` open class BaseClass { fun foo() {} fun bar() {} } class DerivedClass : BaseClass() { override fun bar() {} /** * @suppress */ override fun foo() {} } ``` 在上面的示例中,我们在 `DerivedClass` 中使用 `@suppress` 标签来抑制父类 `BaseClass` 中的 `foo()` 函数,从而在生成的文档中不显示该函数。注意,我们还需要在子类中重新实现 `bar()` 函数,因为我们抑制了父类中的 `foo()` 函数,这使得我们必须要提供一个新的实现,否则子类就会成为抽象类。

android kotlin dsl demo

您想了解有关Android Kotlin DSL的演示吗?对于这样的演示,您可以在GitHub上找到许多可用的示例项目。我可以为您提供几个示例: 1.https://github.com/android/android-ktx/tree/master/kotlin-symbol-processing/demo - 这个示例项目演示了如何使用Kotlin Symbol Processing(KSP)库来生成Kotlin DSL。 2.https://github.com/android/android-ktx/tree/master/kotlin-symbol-processing/demo-dokka-plugin - 这个示例项目演示了如何使用Dokka插件来生成Kotlin DSL。 3.https://github.com/android/android-ktx/tree/master/kotlin-symbol-processing/demo-with-dsl - 这个示例项目演示了如何使用Kotlin DSL生成器来创建定制的Kotlin DSL。 以上是几个Android Kotlin DSL演示的示例项目,您可以自由地探索它们并了解如何在自己的项目中使用Kotlin DSL。

相关推荐

最新推荐

recommend-type

HP-Socket编译-Linux

HP-Socket编译-Linux
recommend-type

JavaScript_生活在Discord上的开源社区列表.zip

JavaScript
recommend-type

JavaScript_MultiOn API.zip

JavaScript
recommend-type

JavaScript_简单和完整的React DOM测试工具,鼓励良好的测试实践.zip

JavaScript
recommend-type

JavaScript_成为一个Nodejs开发者.zip

JavaScript
recommend-type

zigbee-cluster-library-specification

最新的zigbee-cluster-library-specification说明文档。
recommend-type

管理建模和仿真的文件

管理Boualem Benatallah引用此版本:布阿利姆·贝纳塔拉。管理建模和仿真。约瑟夫-傅立叶大学-格勒诺布尔第一大学,1996年。法语。NNT:电话:00345357HAL ID:电话:00345357https://theses.hal.science/tel-003453572008年12月9日提交HAL是一个多学科的开放存取档案馆,用于存放和传播科学研究论文,无论它们是否被公开。论文可以来自法国或国外的教学和研究机构,也可以来自公共或私人研究中心。L’archive ouverte pluridisciplinaire
recommend-type

实现实时数据湖架构:Kafka与Hive集成

![实现实时数据湖架构:Kafka与Hive集成](https://img-blog.csdnimg.cn/img_convert/10eb2e6972b3b6086286fc64c0b3ee41.jpeg) # 1. 实时数据湖架构概述** 实时数据湖是一种现代数据管理架构,它允许企业以低延迟的方式收集、存储和处理大量数据。与传统数据仓库不同,实时数据湖不依赖于预先定义的模式,而是采用灵活的架构,可以处理各种数据类型和格式。这种架构为企业提供了以下优势: - **实时洞察:**实时数据湖允许企业访问最新的数据,从而做出更明智的决策。 - **数据民主化:**实时数据湖使各种利益相关者都可
recommend-type

可见光定位LED及其供电硬件具体型号,广角镜头和探测器,实验设计具体流程步骤,

1. 可见光定位LED型号:一般可使用5mm或3mm的普通白色LED,也可以选择专门用于定位的LED,例如OSRAM公司的SFH 4715AS或Vishay公司的VLMU3500-385-120。 2. 供电硬件型号:可以使用常见的直流电源供电,也可以选择专门的LED驱动器,例如Meanwell公司的ELG-75-C或ELG-150-C系列。 3. 广角镜头和探测器型号:一般可采用广角透镜和CMOS摄像头或光电二极管探测器,例如Omron公司的B5W-LA或Murata公司的IRS-B210ST01。 4. 实验设计流程步骤: 1)确定实验目的和研究对象,例如车辆或机器人的定位和导航。
recommend-type

JSBSim Reference Manual

JSBSim参考手册,其中包含JSBSim简介,JSBSim配置文件xml的编写语法,编程手册以及一些应用实例等。其中有部分内容还没有写完,估计有生之年很难看到完整版了,但是内容还是很有参考价值的。