Domanda

Non riesco a trovare nulla in rete e non sono perfettamente senza ostacoli al supporto del commento XML in DOXYGEN.

Il mio problema è semplice come questo:

/// <see cref="GenericClass{TTypeparam}"/>
.

Quale mi sembra di essere il modo corretto di fare riferimento a un generico aperto nei commenti XML, non produce un collegamento nell'uscita DOXYGEN.Copia solo il testo dall'attributo Cref all'uscita.

So che il collegamento ai generici funziona in DOXYGEN da pagine personalizzate utilizzando GenericClass<TTypeParam>.Così è questo un bug noto, o mi è mancato qualcosa di ovvio?

btw.Sto usando DOXYGEN 1.8.2

È stato utile?

Soluzione

Doxygen non supporta la sintassi {..} all'interno di Cref al momento.Potresti considerarlo come un bug.Sentiti libero di inviare un segnale di bug nel Bug Tracker di DOXYGEN per questo.

Altri suggerimenti

Doxygen non sembra avere un buon modo per gestire i generici al momento (in 1.8.8) - a meno che tu non sia felice di dimenticare il formato XML supportato Microsoft standard (che utilizza {...} sintax) e passare all'utilizzo di "GenerricClass" o "\ Ref GenericClass" (che entrambi sono ovviamente non validi XML che gli utensili di Visual Studio non piaccia).

Vedi bug doxygen https://bugzilla.gnome.org/show_bug.cgi?id= 738173 , https://bugzilla.gnome.org/show_bug.cgi?id= 738167 e https://bugzilla.gnome.org/show_bug.cgi? ID= 704090

Autorizzato sotto: CC-BY-SA insieme a attribuzione
Non affiliato a StackOverflow
scroll top