File: xrefsect.h

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 (34 lines) | stat: -rw-r--r-- 668 bytes parent folder | download | duplicates (6)
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
/**
 *  @file xrefsect.h
 *  A few examples of xrefsect items support.
 */

/**
 * An example of using Doxygen's todo command.
 *
 * @todo Implement this function.
 */
int unimplemented(void);

/**
 * An example of using Doxygen's bug and test commands.
 *
 * @bug Does not work yet.
 *
 * @test Add proper unit testing first.
 */
void buggy_function(int param);

/**
 * An example of using Doxygen's deprecated command.
 *
 * @deprecated Should not be used on new code.
 */
void old_function(void);

/**
 * An example of a custom Doxygen xrefitem declared as an ALIAS.
 *
 * @xrefsample This text shows up in the xref output.
 */
void sample_xrefitem_function(void);