@header tag

This tag can be used to override header file name passed to the #include directive in symbol synopsis section of the documentation.

This is useful when a symbol is actually declared in an internal header source file which should not be included directly.

Default header file name is file path name passed via command line or @parse tag. Use of include path (-I option) can be used to strip path prefix.

See also @prototype tag section.


@header <header file name>


// this is the foo_internal.hh header file

@header mylib/foo.hh

class Foo

Valid XHTML 1.0 StrictGenerated by diaxen on Sun Jan 8 22:43:00 2012 using MkDoc