Dartdoc: Link zu Bezeichnern in SDK auf api.dartlang.org aus einem Drittanbieterpaket

Erstellt am 28. Juli 2015  ·  8Kommentare  ·  Quelle: dart-lang/dartdoc

Unterstützen Sie Links zu Bezeichnern (zum Beispiel List ) des SDK. Links sollten zu Typen in (Klassen-, Methoden-, ...) Signaturen und in Doc-Kommentaren ( Markup-Links ) hinzugefügt werden.

P1 customer angular enhancement help wanted

Alle 8 Kommentare

Gibt es hierzu Neuigkeiten? Könnte es triagiert und mit einer Prioritätsstufe markiert werden, sagen wir, P1 :)

@devoncarew haben wir noch jemanden, der an Dartdoc arbeitet?

@keertip arbeitet daran, aber es ist nicht ihre Hauptaufgabe; Beiträge sind hier willkommen.

@devoncarew - Danke für das Update. Könnten wir diesem Thema zumindest eine Prioritätsstufe zuweisen?
Und vielleicht auch als Hilfe gesucht markieren?

Ist dies eine Anfrage für eine externe Verknüpfung zu api.dartlang.org oder eine Anfrage für Auto-Include-Abhängigkeiten, um dies zu tun?

Ersteres, denke ich.

Ich glaube, es ist eine Anforderung für ein extern generiertes API-Dokument, das standardmäßig SDK-Klassen verwendet, um eine Verknüpfung mit dem SDK-Dokument herzustellen. Wenn beispielsweise ein externes Paket (z. B. args ) eine Eigenschaft hat, die eine Map ist (z. B. Befehle ), möchten die meisten Leute auf Map klicken und zu https://api.dartlang.org/stable/dart-core . gelangen /Map-class.html.

Optionen können sein, (1) diese Links nicht zu generieren oder (2) auf eine bestimmte Version der SDK-API-Dokumentation zu verlinken. Diese Links sollten wahrscheinlich eine andere Standardformatierung haben als Links innerhalb desselben Pakets.

OK. #1368 hat letzteres angesprochen, ersteres ist aber definitiv auf meinem Radar. Ich werde den Titel der Ausgabe anpassen, um klarer zu sein.

1524 sollte dies viel einfacher machen. Dartdoc verfügt nun über ein gewisses elementares Paketgrenzenbewusstsein, mit dem wir bestimmen können, ob alternative Hyperlinks generiert werden sollen, sodass es jetzt nur noch darum geht, die Generierung zu implementieren.

War diese Seite hilfreich?
0 / 5 - 0 Bewertungen