File: variable.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 (40 lines) | stat: -rw-r--r-- 765 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
37
38
39
40

.. _variable-example:

doxygenvariable Directive Example
=================================

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

.. cpp:namespace:: @ex_variable_example

This should work:

.. code-block:: rst

   .. doxygenvariable:: global_cache_tree
      :project: c_file

It produces this output:

.. doxygenvariable:: global_cache_tree
  :project: c_file

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

.. cpp:namespace:: @ex_variable_failing

This intentionally fails:

.. code-block:: rst

   .. doxygenvariable:: made_up_variable
      :project: define

It produces the following warning message:

.. warning::
   doxygenvariable: Cannot find variable “made_up_variable” in doxygen XML output for project
   "tinyxml" from directory: ../../examples/tinyxml/tinyxml/xml/