2013-07-12 5 views
7

Meine Erzählung hat Code-Schnipsel, zB ::SomePlatformAPI(), die nicht Teil meiner Code-Basis und Doxygen warnt davor, dassWie generiert man Inline-Code-Abschnitt mit Doxygen?

warning: explicit link request to 'SomePlatformAPI()' could not be resolved 

Ich versuchte \code und \endcode um es hinzuzufügen, aber dann beginnt der Code-Block einen neuen Absatz und Pausen die aktuelle Erzählung.

Gibt es eine Möglichkeit, Inline-Codeblöcke hinzuzufügen?

UPDATE:

Damit wird nur ein Problem der Doxygen 1,8 sein und oben. Mit 1.6 haben Sie dieses Problem nicht.

Antwort

1

die Lösung selbst gefunden:

Alles, was ich tun muß, ist -> die :: Token und andere ähnlichen Token zu entkommen.

+0

Wie entgehen Sie den Tokens? umgekehrter Schrägstrich? –

+1

@Jasper Blues Ja, es ist Backslash. – kakyo

+0

Die Verwendung von \ '\ #SomePlatformAPI() \' erzeugt immer noch den gleichen Fehler. –

10

Doxygen Markdown-Unterstützung ermöglicht das Einfügen von Inline-Codeblöcken mit dem `Backtick-Zeichen. http://www.stack.nl/~dimitri/doxygen/manual/markdown.html#md_codespan

Wenn Sie dies tun, wird der Code inline injiziert werden, aber es wird monospaced, und Doxygen Verarbeitung wird zwischen den beiden Marken deaktiviert werden. Du musst also keine Token entkommen.

A eine Frage der Tat, es zu machen, noch mehr abheben enthalten ich ein Blatt Extraart mit den folgenden darin:

code 
{ 
    background-color:#EFD25E; 
} 

, dass die Inline-Code hylight wird. Doxygens Codespannen verwenden ein benutzerdefiniertes Tag

<code></code> 
Verwandte Themen