Autodesk / Autodesk/AutomaticComponentToolkit

Multiline API documentation

未关闭
#68 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
Go
星标
53
派生
26
PR 合并指标
30 天内没有已合并 PR

描述

Documentation for elements in ACT IDL is currently specified like so:

```XML

```

Having the description as an attribute makes perfect sense, but when writing an IDL file it makes it very hard to provide comprehensive documentation.

It would be nice, for example, to be able to provide documentation in element form also:

```XML

An extremely useful method.

This is an implementation of Fred Frobricator's notion of _Frobrication_, introduced in
the 1867 paper 'On Frobrication', of which you can find a copy here:

https://www.en.wikipedia.org/wiki/Frobrication

```

(Also happy with any other solution that allows for documentation in a similar for to my example, be it a different syntax for specifying an attribute of which I am unaware, special comments, or whatever.)

贡献指南

打开贡献指南

调研方向

该 issue 没有指出源文件或测试。首先检查当前用于方法描述的 ACT IDL 语法,然后确定应如何表示多行元素形式的文档,并验证所选形式能够被接受且保留完整内容。

由索引模型根据 Issue 内容生成。

评估

领域
api, documentation
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
需要澄清
新手友好度
25/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。