File SBCClassCallableMemberDoc.hpp

FileList > Class > SBCClassCallableMemberDoc.hpp

• #include "SBCClassExport.hpp"
• #include "SBCMetaMacros.hpp"
• #include <string>
• #include <cstdint>
• #include <initializer_list>

Classes

Type	Name
class	SBCClassCallableMemberDoc This class describes documentation for callable members of classes (constructors and member functions).
struct	DocItem An internal structure used to populate docs via the Spec structure in a function's constructor.
struct	ParameterDoc A structure that contains docs for function parameter/argument.
struct	Spec A doc specification (spec) structure used to populate docs via a function's constructor.

Public Types

Type	Name
typedef SBCClassCallableMemberDoc	SBCallableMemberDoc The short name of SBCClassCallableMemberDoc .

Macros

Type	Name
define	SB_CALLABLE_MEMBER_DOC_BRIEF (TEXT) Documentation items that can be used when registering constructors or functions in descriptors of classes (see Introspection ).
define	SB_CALLABLE_MEMBER_DOC_DEPRECATED (TEXT) Documentation item: deprecated.
define	SB_CALLABLE_MEMBER_DOC_NOTE (TEXT) Documentation item: note.
define	SB_CALLABLE_MEMBER_DOC_PARAM (NAME, DOC) Documentation item: parameter.
define	SB_CALLABLE_MEMBER_DOC_RETURNS (DOC) Documentation item: returns.
define	SB_CALLABLE_MEMBER_DOC_SEE_ALSO (TEXT) Documentation item: see also.
define	SB_CALLABLE_MEMBER_DOC_SINCE (TEXT) Documentation item: since.

Public Types Documentation

typedef SBCallableMemberDoc

The short name of SBCClassCallableMemberDoc .

typedef SBCClassCallableMemberDoc SBCallableMemberDoc;

---

Macro Definition Documentation

define SB_CALLABLE_MEMBER_DOC_BRIEF

Documentation items that can be used when registering constructors or functions in descriptors of classes (see Introspection ).

#define SB_CALLABLE_MEMBER_DOC_BRIEF (
    TEXT
) 

Documentation item: brief

---

define SB_CALLABLE_MEMBER_DOC_DEPRECATED

Documentation item: deprecated.

#define SB_CALLABLE_MEMBER_DOC_DEPRECATED (
    TEXT
) 

---

define SB_CALLABLE_MEMBER_DOC_NOTE

Documentation item: note.

#define SB_CALLABLE_MEMBER_DOC_NOTE (
    TEXT
) 

---

define SB_CALLABLE_MEMBER_DOC_PARAM

Documentation item: parameter.

#define SB_CALLABLE_MEMBER_DOC_PARAM (
    NAME,
    DOC
) 

---

define SB_CALLABLE_MEMBER_DOC_RETURNS

Documentation item: returns.

#define SB_CALLABLE_MEMBER_DOC_RETURNS (
    DOC
) 

---

define SB_CALLABLE_MEMBER_DOC_SEE_ALSO

Documentation item: see also.

#define SB_CALLABLE_MEMBER_DOC_SEE_ALSO (
    TEXT
) 

---

define SB_CALLABLE_MEMBER_DOC_SINCE

Documentation item: since.

#define SB_CALLABLE_MEMBER_DOC_SINCE (
    TEXT
) 

---