File: define.rst

package info (click to toggle)
breathe 4.36.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,224 kB
  • sloc: python: 12,703; cpp: 1,737; makefile: 523; xml: 168; sh: 54; ansic: 52
file content (36 lines) | stat: -rw-r--r-- 659 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

.. _define-example:

doxygendefine Directive Example
===============================

Working Example
---------------

This should work:

.. code-block:: rst

   .. doxygendefine:: WRITE_TREE_MISSING_OK
      :project: c_file

It produces this output:

.. doxygendefine:: WRITE_TREE_MISSING_OK
  :project: c_file

Failing Example
---------------

This intentionally fails:

.. code-block:: rst

   .. doxygendefine:: MADEUPDEFINE
      :project: define

It produces the following warning message:

.. warning::
   doxygendefine: Cannot find define "MADEUPDEFINE" in doxygen xml
   output for project "define" in directory: ../../examples/specific/define/xml