Autodesk / Autodesk/AutomaticComponentToolkit

Multiline API documentation

Open
#68 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
53
Forks
26
PR merge metrics
No merged PRs in 30d

Description

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.)

Contributor guide

Open the contributing guide

Research direction

The issue names no source files or tests. Start by reviewing the current ACT IDL syntax for method descriptions, then determine how multiline element-form documentation should be represented and verify that the chosen form is accepted and preserves the full content.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.