Wie Nicht-Member-Funktionen mit einer Klasse in Doxygen verknüpfen?

StackOverflow https://stackoverflow.com/questions/1661575

  •  12-09-2019
  •  | 
  •  

Frage

Ich bin sicher, dass einige Art und Weise gibt es diese mit dem \ defgroup zu tun, \ addgroup und \ @ {\ @} Tags, aber nach ein paar Stunden von Versuch und (natürlich) Fehler, ich frage SO .. ...

ich habe: 

class C {
public:
    void foo () const;
};

und ich habe einige Helfer nicht-Member-Funktionen, die wirklich Teil C der Schnittstelle sind, sind aber nicht in der Klasse: 

std::string
format (const C& c, const std::string &fmt);

Ich mag die Formatierungsfunktion auf der gleichen Seite wie die Klassenfunktionen erscheinen. Ist das einfach nicht möglich? Ist die beste, was ich kann eine „Modul“ Seite, die C als Klasse Listen (mit einem Hyperlink zu C Kommentaren und Format als Funktion?

War es hilfreich?

Lösung

\ bezieht (oder \ memberof) scheinen zu sein, was Sie suchen.

Andere Tipps

Eine Gruppe erstellen und Funktionen außerhalb der Klasse in dieser Gruppe zuweisen wird funktionieren, aber in der Klasse Dokumentation selbst, werden Sie keine Verweise auf Ihre Funktionen bekommen, wenn Sie Befehle wie @see oder @sa verwenden. Ehrlich gesagt, da eine Funktion einen dokumentierten Parameter übernimmt diese Funktion nicht bedeuten automatisch Teil der Bibliothek ist, aber Sie können beide Klassen verknüpfen und Funktionen zusammen @defgroup und @addgroup verwendet wird.

Lizenziert unter: CC-BY-SA mit Zuschreibung
Nicht verbunden mit StackOverflow
scroll top