Posso usare un intervallo di codice esistente (indica alcune righe di codice da un file cpp
) come esempio nel doxygen docu?
/*! * \brief My Foo class * \details More about foo * \example?? Foo used like here, some LOC from cpp follow (how can I do that??) */ class Foo
Voglio mostrare 3-10 linee di codice esistente su come ho usato Foo
. Quelle 3-10 linee dovrebbero provenire da un file cpp
.
Capisco che devo taggare il file cpp
con \file
, ma come faccio a fare riferimento ad alcune linee di codice?
Qualcosa di simile (codice pseudo errato, perché non ho idea di come farlo)
somewhereelse.cpp ... ... //! \example Foo (supposed to display with Foo docu). This is how Foo is used //! @{ Foo f; f.init(); // init first f.start(); // then start //! }@ ...
Come indicato da albert (commenti sopra) \snippet
può essere usato. Un esempio completo può essere trovato qui https://stackoverflow.com/a/16034375/356726
Fai riferimento a un file e in quel file ( .cpp
nel mio scenario) contrassegni il blocco con parentesi []
. Apparirà quindi come blocco di codice.