IMP logo
IMP Reference Guide  develop.1a04b19ae7,2021/11/27
The Integrative Modeling Platform
doxygen_macros.h File Reference

Helper macros for writing doxygen documentation. More...

#include <IMP/kernel_config.h>
#include "swig_macros.h"
+ Include dependency graph for doxygen_macros.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define IMP_IMPLEMENT(signature)
 
#define IMP_IMPLEMENT_INLINE(signature, body)
 
#define IMP_IMPLEMENT_INLINE_NO_SWIG(signature, body)
 
#define IMP_IMPLEMENTATION_TEMPLATE_1(arg0, signature, body)
 
#define IMP_IMPLEMENTATION_TEMPLATE_2(arg0, arg1, signature, body)
 
#define IMP_NO_DOXYGEN(x)
 Hide something from doxygen. More...
 
#define IMP_ONLY_DOXYGEN(x)   x IMP_REQUIRE_SEMICOLON_CLASS(only_doxy)
 Only show something to doxygen. More...
 
#define IMP_SWITCH_DOXYGEN(x, y)   x
 

Detailed Description

Helper macros for writing doxygen documentation.

Copyright 2007-2021 IMP Inventors. All rights reserved.

Definition in file doxygen_macros.h.

Macro Definition Documentation

#define IMP_IMPLEMENT (   signature)

Declare a method that implements a method that is pure virtual in the base class.

Definition at line 33 of file doxygen_macros.h.

#define IMP_IMPLEMENT_INLINE (   signature,
  body 
)

Define a method inline that implements a pure virtual method.

Definition at line 36 of file doxygen_macros.h.

#define IMP_IMPLEMENT_INLINE_NO_SWIG (   signature,
  body 
)

Define a method inline that implements a pure virtual method that is hidden from swig.

Definition at line 41 of file doxygen_macros.h.

#define IMP_IMPLEMENTATION_TEMPLATE_1 (   arg0,
  signature,
  body 
)

Define an implementation detail template method.

Definition at line 45 of file doxygen_macros.h.

#define IMP_NO_DOXYGEN (   x)

Hide something from doxygen.

Definition at line 18 of file doxygen_macros.h.

#define IMP_ONLY_DOXYGEN (   x)    x IMP_REQUIRE_SEMICOLON_CLASS(only_doxy)

Only show something to doxygen.

Definition at line 21 of file doxygen_macros.h.