Databases
StackOverflow2013
Postsdbo
POHow can I include a subset of a .cpp file in a Doxygen comment?
 

Note that there are some explanatory texts on larger screens.

plurals
  1. POHow can I include a subset of a .cpp file in a Doxygen comment?
    primarykey
    data
    text
    <p>I'm trying to write some Doxygen comment blocks, and I'd like to include example snippets of code. Of course, I'd like the examples to actually compile so they don't get stale.</p> <p>My example.cpp (that I \include in the .h file) looks like this:</p> <pre><code>#include "stdafx.h" #include "../types_lib/Time_Limiter.h" #include &lt;vector&gt; void tl_demo () { // scarce will be a gate to control some resource that shouldn't get called // more than 10 times a second Time_Limiter scarce (10); // here's a bunch of requests std::vector&lt;int&gt; req (500); for (size_t i=0;i&lt;req.size ();i++) { scarce.tick (); // once we get here, we know that we haven't ticked // more than 10 times in the last second. // do something interesting with req[i] } } // endcode </code></pre> <p>and my header file (that I'm running Doxygen) looks like this:</p> <pre><code>/** * \ingroup types_lib * * \class Time_Limiter * * \brief Thread safe gate used to control a resource (such as an internet quote service) that has a limit on how often you can call it. * * \dontinclude Time_Limiter_example.cpp * \skipline void * \until endcode * **/ </code></pre> <p>And I'd like to get doxygen to just include stuff starting at "void demo" to the end of the file (but without the // endcode).</p> <p>I've tried experimenting with \dontinclude and \skip, \skipline, and \until, and I can't quite figure out the right incantations.</p> <p>EDIT: included my .h file, and now I've almost got the right incantation. This does <em>almost</em> exactly what I want, is there some way to use \until without a tag, and get rid of that last // endcode line from example.cpp?</p>
    singulars
    1. PO
      singulars
      1. PTAnswer
    1. This table or related slice is empty.
    1. PTQuestion
    1. USEric H.
    1. USEric H.
    plurals
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. PO
      singulars
      1. PTAnswer
    2. PO
      singulars
      1. PTAnswer
    3. PO
      singulars
      1. PTAnswer
    1. VO
      singulars
      1. POHow can I include a subset of a .cpp file in a Doxygen comment?
      1. This table or related slice is empty.
      1. VTUpMod
    2. VO
      singulars
      1. POHow can I include a subset of a .cpp file in a Doxygen comment?
      1. This table or related slice is empty.
      1. VTUpMod
    3. VO
      singulars
      1. POHow can I include a subset of a .cpp file in a Doxygen comment?
      1. This table or related slice is empty.
      1. VTUpMod
    1. CODid you properly set the EXAMPLE_PATH in the doxyfile?
      singulars
      1. POHow can I include a subset of a .cpp file in a Doxygen comment?
      1. USÉric Malenfant
    2. COYes. the text is included, I'm just trying to figure out some incantation so that I don't have to see the three #includes at the beginning.
      singulars
      1. POHow can I include a subset of a .cpp file in a Doxygen comment?
      1. USEric H.
    3. COAnd you saw the example at http://www.stack.nl/~dimitri/doxygen/commands.html#cmddontinclude ?
      singulars
      1. POHow can I include a subset of a .cpp file in a Doxygen comment?
      1. USÉric Malenfant
 

Querying!

 
Guidance
A row detail

Detail views are divided into sections. All the information in the data section comes from columns in the selected row. The other sections display data from other, related rows.

Related data can be related in a to-one or a to-many fashion. Captions of data related in a to-many fashion link to a list view showing a filtered view of the table.

Try moving around until you find a non-empty to-many entry and click on the label to get to one. You can move back to the root by clicking on the database name in the header.

SQuiL has stopped working due to an internal error.

If you are curious you may find further information in the browser console, which is accessible through the devtools (F12).

Reload