Autodesk / Autodesk/AutomaticComponentToolkit

Multiline API documentation

Ouverte
#68 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
Langage dominant
Go
Étoiles
53
Forks
26
Métriques de merge des PR
Aucune PR mergée en 30 j

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

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

L’issue ne nomme aucun fichier source ni aucun test. Commencez par examiner la syntaxe actuelle de ACT IDL pour les descriptions de méthodes, puis déterminez comment la documentation au format d’élément multiligne doit être représentée et vérifiez que la forme choisie est acceptée et préserve l’intégralité du contenu.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Domaine
api, documentation
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.