Beim Durchsehen der C- und C ++ - Domänen von Sphinx scheint es keine native Unterstützung für die Dokumentation zu geben enums (und viel weniger anonym enums). Ab sofort benutze ich cpp:type:: für den Enum-Typ, und dann eine Liste aller möglichen Werte und deren Beschreibung, aber das scheint kein idealer Weg zu sein, um damit umzugehen, vor allem, weil es den Verweis auf bestimmte Werte zu einem Schmerz macht (entweder referenziere ich nur den Typ oder füge einen zusätzlichen Marker vor dem Wert hinzu).
Gibt es einen besseren Weg, dies zu tun? Und wie würde ich mit anonymen Enums umgehen?
Ein Projekt auf Github, Spdylay, scheint einen Ansatz zu haben. Eine der Header-Dateien bei Ссылка hat einen solchen Code:
%Vor% Es gibt eine Beschreibung, wie sie es bei Ссылка machen, was die Verwendung von a beinhaltet API-Generator namens mkapiref.py , verfügbar unter
Ссылка
Die RST, die für dieses Beispiel generiert wird, ist
%Vor%Du könntest einen Blick darauf werfen und sehen, ob es für dich nützlich ist.
Hi Vielleicht sollten Sie doxygen für die Dokumentation in Betracht ziehen, da es viel mehr native Unterstützung für c / c ++ bietet . Wenn du die Sphinx-Ausgabe deiner Dokumentation behalten willst, kannst du von doxygen als XML ausgeben, dann brauchst du Breathe und nimm das xml und dir die gleiche Sphinx-Ausgabe geben, die du gewohnt bist.
Hier ist ein Beispiel für die Dokumentation eines Enums im Doxygen-Format von der Breathe-Website.
%Vor%hoffe das hilft.
Tags und Links c++ python-sphinx restructuredtext